创建一个任务到集群中运行。您可以指定数据源配置、代码源配置、启动命令以及任务运行的每个节点的计算资源配置等信息。
接口说明
请确保在使用该接口前，已充分了解PAI-DLC产品的收费方式和价格。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
当前API暂无授权信息透出。
请求语法
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 | object [] | 否 |
任务运行所使用的数据源列表。 |
|
| DataSourceId | string | 否 |
数据源的ID。如何查看数据源ID，请参见ListDatasets。 |
d-cn9dl******* |
| MountPath | string | 否 |
本任务需要挂载的路径，可选参数，默认使用数据源中的挂载路径。 |
/root/data |
| 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 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回JSON格式字符串。 |
||
| JobId | string |
此次调用创建的任务ID。 |
dlc7******* |
| RequestId | string |
本次请求的ID，用于诊断和答疑。 |
473469C7-AA6F-4DC5-B3DB-xxxxxxx |
示例
正常返回示例
JSON格式
{
"JobId": "dlc7*******",
"RequestId": "473469C7-AA6F-4DC5-B3DB-xxxxxxx"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2023-09-11 | API 内部配置变更，不影响调用 | 看变更集 | ||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/164320.html