建立作業（App類型） -

CreateJob

描述

建立一個使用 App 的 job 資源。

要求方法

說明

POST /jobs

請求訊息體

{
    "Name": string,
    "Description": string,
    "Type": "App",
    "App": {
        "AppName": string,
        "Inputs": {
            string: Any
        },
        "Outputs": {
            string: string
        },
        "Logging": {
            "StdoutPath": string,
            "StderrPath": string
        },
        "Config": {
            "ResourceType": string,
            "InstanceType": string,
            "InstanceCount": number,
            "MinDiskSize": number,
            "DiskType": string,
            "MinDataDiskSize":number,
            "DataDiskType": string,
            "DataDiskMountPoint": string,
            "MaxRetryCount": number,
            "Timeout": number,
            "ReserveOnFail": boolean
        }
    }
}

請求參數

參數

參數名稱	類型	必選	描述
Name	string	是	作業名稱。允許的字元集為[a-zA-Z0-9_-]，長度不能大於100，不可為空
Description	string	否	作業的詳細描述。長度不能大於1000。預設值：空
Type	string	是	作業類型。App 類型的作業其值必須為：App
AppName	string	是	app name。允許的字元集為[a-zA-Z0-9_-:]，長度不能大於1024。App 名 Name 有兩種格式，分別用於訪問公用的 App 和自己私人的 App。比如，要訪問公用 App 名字是 App1，則可以設定為 Public：App1，其中的 Public 可以省略，變為：App1。如果 App1 是自己的私人 App，則直接設定為 App1。
Inputs	map<string, Any>	是	作業輸入參數。Map 大小不能大於50，不能小於0。Key 應為 App 中 InputParameters 定義的參數名，Value 應當與 App 中參數定義的類型相同。
outputs	map<string, string>	否	作業輸出參數。Map 大小不能大於50，不能小於0。Key 應為 App 中 OutputParameters 定義的 LocalPath 不為空白的參數名，Value 應當為某個 OSS 路徑。預設值：{}
Logging	object(Logging)	否	日誌配置
Config	object(Config)	否	作業運行時配置

Logging

參數名稱	類型	必選	描述
StdoutPath	string	否	標準輸出重新導向到 OSS 的目錄。長度不能大於1000。預設值：空
StderrPath	string	否	標準錯誤重新導向到 OSS 的目錄。長度不能大於1000。預設值：空

Config

參數名稱	類型	必選	描述
ResourceType	string	否	資源類型。可以取值為：OnDemand，Spot。預設值為 App 中定義的值。
InstanceType	string	否	ECS 執行個體類型。預設值為 App 中定義的值。
InstanceCount	number	否	並發執行執行個體個數。預設值為 App 中定義的值。
MinDiskSize	number	否	最小系統硬碟大小（單位 GB）。預設值為 App 中定義的值。
DiskType	string	否	系統硬碟類型。預設值為 App 中定義的值。
MinDataDiskSize	number	否	最小資料盤大小（單位 GB）。預設值為 App 中定義的值。
DataDiskType	string	否	資料盤類型。預設值為 App 中定義的值。
DataDiskMountPoint	string	否	資料盤掛載點。預設值為 App 中定義的值。
MaxRetryCount	number	否	某個 Instance 失敗後，最大重試次數。預設值為 App 中定義的值。
Timeout	number	否	Instance 的運行時逾時時間，單位為秒。預設值為 App 中定義的值。
ReserveOnFail	boolean	否	作業失敗後，是否保留虛擬機器，以待調查問題。預設值為 false。

響應

響應狀態代碼

說明

201

響應訊息體

{
    "Id": string
}

響應參數

參數名稱	類型	描述
Id	string	資源Id

樣本

請求樣本

POST /jobs
{
    "Name": "job_name",
    "Description": "job description",
    "Type": "App",
    "App": {
        "AppName": "myapp",
        "Inputs": {
            "inputFile": "oss://bucket/a"
        },
        "Outputs": {
            "outputFile": "oss://bucket/b"
        },
        "Config": {
            "InstanceType": "ecs.s3.large"
        },
        "Logging": {
            "StdoutPath": "oss://bucket/logging/",
            "StderrPath": "oss://bucket/logging/"
        }
    }
}

返回樣本

HTTP/1.1 201 Created
{
    "Id": "job-0000123"
}