創建一個任務到集群中運行。您可以指定數據源配置、代碼源配置、啟動命令以及任務運行的每個節點的計算資源配置等信息。
接口說明
請確保在使用該接口前,已充分了解 PAI-DLC 產品的收費方式和價格。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
paidlc:CreateJob | create |
|
| 無 |
請求語法
POST /api/v1/jobs
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 請求 Body 參數。 | |
DisplayName | string | 是 | 任務的名稱,命名格式如下:
| tf-mnist-test |
JobType | string | 是 | 任務類型,大小寫敏感。當前支持的任務類型:
| TFJob |
JobSpecs | array | 是 | JobSpecs 描述任務運行時的各種配置,諸如鏡像地址、啟動命令、節點資源申明、副本數量等。 DLC 任務由不同類型的節點組成,同一類型的節點擁有完全相同的配置,這種配置被稱為一個 JobSpec。JobSpecs 描述所有類型節點的配置,是 JobSpec 的數組。 | |
JobSpec | 否 | 任務的運行時配置。 | ||
UserCommand | string | 是 | 任務所有節點的啟動命令。 | python /root/code/mnist.py |
DataSources | array<object> | 否 | 任務運行所使用的數據源列表。 | |
object | 否 | 本任務使用的所有數據源列表。按照數據源中的配置 mount 到每一個節點所在的容器本地目錄上(本地目錄由數據源中的配置 MountPath 指定)。 任務的啟動命令中的進程以 MountPath 為路徑直接訪問每一個數據源代表的分布式文件系統。 | ||
DataSourceId | string | 否 | 數據源的 ID。如何查看數據源 ID,請參見 ListDatasets 。 | d-cn9dl******* |
MountPath | string | 否 | 本任務需要掛載的路徑,可選參數,默認使用數據源中的掛載路徑。 | /root/data |
Uri | string | 否 | 數據源路徑。 | oss://bucket.oss-cn-hangzhou-internal.aliyuncs.com/path/ |
Options | string | 否 | 自定義數據集掛載屬性,目前僅支持 OSS。 | { "fs.oss.download.thread.concurrency": "10", "fs.oss.upload.thread.concurrency": "10", "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink" } |
CodeSource | object | 否 | 本任務使用的代碼源。任務的節點啟動之前,DLC 會自動下載代碼源中配置好的代碼,并 Mount 到容器的本地目錄。 | |
CodeSourceId | string | 否 | 代碼源 ID。如何獲取代碼源 ID,請參見ListCodeSources 。 | code-20210111103721-xxxxxxx |
Branch | string | 否 | 本任務運行時,引用的代碼倉庫的分支,可選參數,默認使用代碼源中的配置分支字段。 | master |
Commit | string | 否 | 本任務需要下載的代碼 Commit ID,可選參數,默認使用代碼源中的 CommitID 配置。 | 44da109b5****** |
MountPath | string | 否 | 本次任務需要掛載的路徑,可選參數,默認使用代碼源中配置掛載路徑。 | /root/data |
UserVpc | object | 否 | 用戶 VPC 配置。 | |
VpcId | string | 否 | 用戶 VPC 的 ID。 | vpc-abcdef**** |
SwitchId | string | 否 | 用戶交換機的 ID,可選參數
| vs-abcdef**** |
SecurityGroupId | string | 否 | 用戶安全組的 ID。 | sg-abcdef**** |
ExtendedCIDRs | array | 否 | 擴展網段
| |
string | 否 | 擴展網段。 | 192.168.0.1/24 | |
DefaultRoute | string | 否 | 默認路由。取值如下:
| eth0 |
ThirdpartyLibs | array | 否 | 待安裝的 Python 三方庫列表。 | |
string | 否 | 指定一個第三方 Python 庫和對應版本要求,例如: | numpy==1.16.1 | |
ThirdpartyLibDir | string | 否 | Python 三方庫(requirements.txt)文件所在文件夾名稱;每個節點在運行指定的 UserCommand 之前,PAI-DLC 會從指定文件夾取出 requirements.txt 文件,并調用 | /root/code/ |
Envs | object | 否 | 環境變量配置。 | |
string | 否 | 一個環境變量,格式: | ENABLE_DEBUG_MODE | |
JobMaxRunningTimeMinutes | long | 否 | 作業最長運行時長,單位為分鐘。 | 1024 |
WorkspaceId | string | 否 | 工作空間 ID,如何獲取工作空間 ID,請參見 ListWorkspaces 。 | ws-20210126170216-xxxxxxx |
ResourceId | string | 否 | 資源組 ID,可選參數。
| rs-xxx |
Priority | integer | 否 | 任務的優先級,可選參數,默認值 1,參數值的范圍是 1~9。其中:
| 8 |
Settings | JobSettings | 否 | 作業額外參數配置。 | |
ElasticSpec | JobElasticSpec | 否 | 該參數暫未支持,無需關注。 | |
DebuggerConfigContent | string | 否 | 該參數暫未支持,無需關注。 | “” |
Options | string | 否 | 本任務的額外配置,通過此參數可以調整掛載的數據源的一些行為。如任務有掛載 OSS 類型的數據源時,可以通過將此參數配置為 | key1=value1,key2=value2 |
SuccessPolicy | string | 否 | 分布式多機任務的成功策略,目前只有 Tensorflow 的多機任務支持。
| AllWorkers |
CredentialConfig | CredentialConfig | 否 | 訪問憑證配置。 | |
Accessibility | string | 否 | 作業的可見性,取值如下:
| PRIVATE |
返回參數
示例
正常返回示例
JSON
格式
{
"JobId": "dlc7*******",
"RequestId": "473469C7-AA6F-4DC5-B3DB-xxxxxxx"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-09 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2024-07-05 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-12-08 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-09-11 | API 內部配置變更,不影響調用 | 查看變更詳情 |