文档

CreateJob - 创建任务

更新时间:

创建一个任务到集群中运行。您可以指定数据源配置、代码源配置、启动命令以及任务运行的每个节点的计算资源配置等信息。

接口说明

请确保在使用该接口前,已充分了解 PAI-DLC 产品的收费方式和价格

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/jobs

请求参数

名称类型必填描述示例值
bodyobject

请求 Body 参数。

DisplayNamestring

任务的名称,命名格式如下:

  • 名称长度不超过 256 个字符。
  • 允许数字、字母、下划线(_)、英文句号(.)和短横线(-)。
tf-mnist-test
JobTypestring

任务类型,大小写敏感。当前支持的任务类型:

  • TFJob
  • PyTorchJob
  • XGBoostJob
  • OneFlowJob
  • ElasticBatch
TFJob
JobSpecsarray

JobSpecs 描述任务运行时的各种配置,诸如镜像地址、启动命令、节点资源申明、副本数量等。

DLC 任务由不同类型的节点组成,同一类型的节点拥有完全相同的配置,这种配置被称为一个 JobSpec。JobSpecs 描述所有类型节点的配置,是 JobSpec 的数组。

JobSpec

任务的运行时配置。

UserCommandstring

任务所有节点的启动命令。

python /root/code/mnist.py
DataSourcesobject []

任务运行所使用的数据源列表。

DataSourceIdstring

数据源的 ID。如何查看数据源 ID,请参见 ListDatasets

d-cn9dl*******
MountPathstring

本任务需要挂载的路径,可选参数,默认使用数据源中的挂载路径。

/root/data
CodeSourceobject

本任务使用的代码源。任务的节点启动之前,DLC 会自动下载代码源中配置好的代码,并 Mount 到容器的本地目录。

CodeSourceIdstring

代码源 ID。如何获取代码源 ID,请参见ListCodeSources

code-20210111103721-xxxxxxx
Branchstring

本任务运行时,引用的代码仓库的分支,可选参数,默认使用代码源中的配置分支字段。

master
Commitstring

本任务需要下载的代码 Commit ID,可选参数,默认使用代码源中的 CommitID 配置。

44da109b5******
MountPathstring

本次任务需要挂载的路径,可选参数,默认使用代码源中配置挂载路径。

/root/data
UserVpcobject

用户 VPC 配置。

VpcIdstring

用户 VPC 的 ID。

vpc-abcdef****
SwitchIdstring

用户交换机的 ID,可选参数

  • 参数值为空时系统会根据库存情况自动选择合适的交换机;
  • 也可以自己指定交换机 ID。
vs-abcdef****
SecurityGroupIdstring

用户安全组的 ID。

sg-abcdef****
ExtendedCIDRsarray

扩展网段

  • 当交换机 ID 为空时,此参数可以不提供,系统会自动获取 VPC 下的所有网段;
  • 当交换机 ID 不为空时,此参数必须提供,建议填写 VPC 下的所有网段。
string

扩展网段。

192.168.0.1/24
DefaultRoutestring

默认路由。取值如下:

eth0
ThirdpartyLibsarray

待安装的 Python 三方库列表。

string

指定一个第三方 Python 库和对应版本要求,例如:numpy==1.16.1

numpy==1.16.1
ThirdpartyLibDirstring

Python 三方库(requirements.txt)文件所在文件夹名称;每个节点在运行指定的 UserCommand 之前,PAI-DLC 会从指定文件夹取出 requirements.txt 文件,并调用pip install -r安装。

/root/code/
Envsobject

环境变量配置。

string

一个环境变量,格式:Key=Value

ENABLE_DEBUG_MODE
JobMaxRunningTimeMinuteslong

作业最长运行时长,单位为分钟。

1024
WorkspaceIdstring

工作空间 ID,如何获取工作空间 ID,请参见 ListWorkspaces

ws-20210126170216-xxxxxxx
ResourceIdstring

资源组 ID,可选参数。

  • 参数值为空表示提交到公共资源组。
  • 如果当前工作空间已经绑定专有资源组,此处可以指定对应的资源组 ID;如何创建专有资源组、查询专有资源组 ID,详情请参见准备及管理 DLC 资源组集群
rs-xxx
Priorityinteger

任务的优先级,可选参数,默认值 1,参数值的范围是 1~9。其中:

  • 1 为最低优先级。
  • 9 为最高优先级。
8
SettingsJobSettings

作业额外参数配置。

ElasticSpecJobElasticSpec

该参数暂未支持,无需关注。

DebuggerConfigContentstring

该参数暂未支持,无需关注。

“”
Optionsstring

本任务的额外配置,通过此参数可以调整挂载的数据源的一些行为。如任务有挂载 OSS 类型的数据源时,可以通过将此参数配置为 fs.oss.download.thread.concurrency=4,fs.oss.download.queue.size=16 ,覆盖 JindoFS 的默认参数。

key1=value1,key2=value2
SuccessPolicystring

分布式多机任务的成功策略,目前只有 Tensorflow 的多机任务支持。

  • ChiefWorker:当指定为这个值的时候,只要 Chief 的 pod 成功结束,那么就认为整个任务成功结束。
  • AllWorkers(默认值):必须是所有的 Worker 全部成功,才会认为整个任务成功。
AllWorkers

返回参数

名称类型描述示例值
object

返回 JSON 格式字符串。

JobIdstring

此次调用创建的任务 ID。

dlc7*******
RequestIdstring

本次请求的 ID,用于诊断和答疑。

473469C7-AA6F-4DC5-B3DB-xxxxxxx

示例

正常返回示例

JSON格式

{
  "JobId": "dlc7*******",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-xxxxxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-08API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-09-11API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈