CreateApp
描述
創建一個 app 資源
請求語法
請求行:
POST /apps?IdempotentToken=vU7xaM9YCqqAFHAVvRVynoMBZSgD0MPn HTTP/1.1
請求方法 POST,請求資源為 apps,請求參數為:
屬性名稱 | 類型 | 是否必須 | 描述 |
---|---|---|---|
IdempotentToken | string | 否 | 用于保證請求的冪等性。由用戶生成該參數值,要保證在不同請求間唯一,最大不值過64個字符,字符包括了字母、數字以及下劃線。 |
請求數據:
請求數據以 JSON 格式描述:
{
"Name": "test-copy",
"Description": "Copy input file to output file",
"CommandLine": "cp -rf ${inputFile} ${outputFile}",
"Daemonize": false,
"EnvVars": {
"key1": "value1",
"key2": "value2"
},
"InputParameters": {
"inputFile": {
"Description": "Input param",
"Type": "String",
"Default": "",
"LocalPath": "/tmp/infile/"
}
},
"OutputParameters": {
"outputFile": {
"Type": "String",
"Description": "Output param",
"LocalPath": "/tmp/outfile/"
}
},
"VM": {
"ECSImageId": "img-unbuntu"
},
"Docker": {
"Image": "ubuntu:14.04",
"RegistryOSSPath": "oss://bucket/registry"
},
"Config": {
"ResourceType": {
"Description": "Resource type",
"Default": "OnDemand",
"Overwritable": true
},
"InstanceType": {
"Description": "Instance type",
"Default": "ecs.sn2ne.large",
"Overwritable": true
},
"InstanceCount": {
"Description": "Instance count",
"Default": 1,
"Overwritable": true
},
"DiskType": {
"Description": "Disk type",
"Default": "cloud_efficiency",
"Overwritable": true
},
"MinDiskSize": {
"Description": "Min Disk size",
"Default": 40,
"Overwritable": true
},
"MinDataDiskSize": {
"Default": 100,
"Description": "Min data disk size",
"Overwritable": true
},
"DataDiskType": {
"Default": "cloud_efficiency",
"Description": "Data disk type",
"Overwritable": true
},
"DataDiskMountPoint": {
"Default": "/home/mount/",
"Description": "Data disk mount point",
"Overwritable": true
},
"MaxRetryCount": {
"Description": "Max retry count",
"Default": 2,
"Overwritable": true
},
"Timeout": {
"Description": "Time out",
"Default": 600000,
"Overwritable": true
}
}
}
屬性說明:
參數
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Name | string | 是 | 應用名稱。允許的字符集為[a-zA-Z0-9_-],長度不能大于64,不能為空 |
Description | string | 否 | 應用的詳細描述。長度不能大于1000。默認值:空 |
InputParameters | map<string, object(InputParameter)> | 否 | 該應用的輸入參數列表。Map 大小不能大于50,不能小于0。對于 Key,允許的字符集為[a-zA-Z0-9_-],長度不能大于100。默認值:{} |
OutputParameters | map<string, object(OutputParameter)> | 否 | 該應用的輸出參數列表。Map 大小不能大于50,不能小于0。對于 Key,允許的字符集為[a-zA-Z0-9_-],長度不能大于100。默認值:{} |
Docker | object(Docker) | 否 | Docker 鏡像有關配置。 Docker 和 VM 屬性只能配置一個,并且必須要配置一個 |
VM | object(VM) | 否 | ECS 虛擬機相關配置 |
CommandLine | string | 是 | 執行應用時的命令行。長度不能大于1000 |
EnvVars | map<string, string> | 否 | 環境變量。Map 大小不能大于50,不能小于0。對于 Key,允許的字符集為[a-zA-Z0-9_-],長度不能大于100。對于 Value,長度不能大于1000。默認值:{} |
Daemonize | boolean | 否 | 應用在執行時,是否每次都要重新啟動。默認值:False |
Config | object(Config) | 否 | 提交作業時的運行時參數 |
InputParameter
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 參數描述。長度不能大于1000。默認值:空 |
Type | string | 否 | 參數類型。枚舉類型,可選值為:String、Number。默認值:String |
Default | Any | 否 | 參數默認值。類型必須與 Type 指定的類型相同。默認值:null |
LocalPath | string | 否 | LocalPath 不為空說明該參數是 OSS 上的一個文件或者目錄。在計算分析時,系統會將該參數值指定的 OSS 文件或者目錄映射為本地 LocalPath 指定的文件或者目錄。僅支持使用 UTF-8 編碼。如果是目錄,則必須以 “/“ 結尾。長度不能大于1000。默認值:空 |
OutputParameter
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 參數描述。長度不能大于1000。默認值:空 |
Type | string | 否 | 參數類型。枚舉類型,可選值為:String、Number。默認值:String |
LocalPath | string | 否 | LocalPath 不為空說明該參數是 OSS 上的一個文件或者目錄。在計算分析時,系統會將本地 LocalPath 指定的文件或者目錄映射為該參數值指定的 OSS 文件或者目錄。僅支持使用 UTF-8 編碼。如果是目錄,則必須以 “/“ 結尾。長度不能大于1000。默認值:空 |
Docker
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Image | string | 是 | Docker 鏡像。長度不能大于1000 |
RegistryOSSPath | string | 否 | docker registry storage 在 OSS 上的根目錄。長度不能大于1000。默認值:空 |
VM
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
ECSImageId | string | 是 | ECS 鏡像 Id。允許的字符集為[a-zA-Z0-9_-],長度不能大于100 |
Config
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
ResourceType | object(ResourceType) | 否 | 資源類型 |
InstanceType | object(InstanceType) | 否 | 實例類型 |
InstanceCount | object(InstanceCount) | 否 | 實例數量 |
MinDiskSize | object(MinDiskSize) | 否 | 最小系統盤大小 (GB) |
DiskType | object(DiskType) | 否 | 系統盤類型 |
MinDataDiskSize | object(MinDataDiskSize) | 否 | 最小數據盤大小 (GB) |
DataDiskType | object(DataDiskType) | 否 | 數據盤類型,需要和系統盤類型保持一致 |
DataDiskMountPoint | object(DataDiskMountPoint) | 否 | 數據盤掛載點 |
MaxRetryCount | object(MaxRetryCount) | 否 | 某個 Instance 失敗后,最大重試次數 |
Timeout | object(Timeout) | 否 | Instance 的運行時超時時間,單位為秒 |
ResourceType
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | string | 否 | 參數默認值。枚舉類型,可選值為:OnDemand、Spot。默認值:OnDemand |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
InstanceType
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | string | 否 | 參數默認值。長度不能大于1000。默認值:空 |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
InstanceCount
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | number | 否 | 參數默認值。必須為整數,不能大于1000,不能小于0。默認值:1 |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
MinDiskSize
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | number | 否 | 參數默認值。必須為整數,不能大于500,不能小于40。默認值:40 |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
DiskType
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | string | 否 | 參數默認值。枚舉類型,可選值為:cloud、ephemeral、cloud_efficiency。默認值:cloud_efficiency |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
MinDataDiskSize
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | string | 否 | 參數默認值。必須為整數,不能大于32768,不能小于20。默認值:0,表示不使用數據盤 |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
DataDiskType
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | string | 否 | 參數默認值。枚舉類型,可選值為:cloud、ephemeral、cloud_efficiency,但是必須和系統盤類型 DiskType 保持一致。默認值:cloud_efficiency |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
DataDiskMountPoint
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | string | 否 | 參數默認值。字符串類型,指定數據盤的掛載點,長度不能大于1000。在 Windows 環境下只能指定到特定的盤符,如 “D:”,盤符字母從 A-Z,除 C 以外均可。默認值:空 |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
MaxRetryCount
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | number | 否 | 參數默認值。必須為整數,不能大于1000,不能小于0。默認值:0 |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
Timeout
參數名稱 | 類型 | 必選 | 描述 |
---|---|---|---|
Description | string | 否 | 給 APP 使用者的詳細描述。長度不能大于1000。默認值:空 |
Default | number | 否 | 參數默認值。必須為整數,不能大于1000000000,不能小于0。默認值:86400 |
Overwritable | boolean | 否 | 用戶使用該 APP 提交作業時,是否可以覆蓋掉默認值。默認值:True |
返回信息
成功
響應行:
HTTP/1.1 201 Created
響應數據:
{
"Name": "test-copy"
}
響應參數
參數名稱 | 類型 | 描述 |
---|---|---|
Name | string | App 標識符 |
錯誤
文檔內容是否對您有幫助?