CreateJob
创建一个任务到集群中运行。您可以指定数据源配置、代码源配置、启动命令以及任务运行的每个节点的计算资源配置等信息
服务地址:
华东1(杭州)
输入参数
只看必填
body请求Body参数
DisplayName任务的名称
JobType任务类型
JobSpecsJobSpecs描述任务运行时的各种配置
0描述一种类型的Worker的详细配置
TypeType与Job Type紧密相关
Image此类Worker的运行镜像地址
ImageConfig私有镜像信息配置
DockerRegistry镜像仓库地址
Username镜像仓库用户名
Password镜像仓库密码
Auth镜像仓库认证信息
PodCount副本数量
EcsSpecWorker的硬件规格
ExtraPodSpec额外Pod配置
InitContainers初始化容器
0容器参数
Name容器名称
Image容器镜像地址
Command用户命令
0命令行
Args命令参数
0参数
WorkingDir容器内工作目录
Env环境变量
0环境变量
Name环境变量名称
Value环境变量值
Resources容器资源
Limits资源限制
:
Requests资源需求
:
PodAnnotationsPod注解
:
SideCarContainers伴随容器
0容器参数
Name容器名称
Image容器镜像地址
Command用户命令
0命令行
Args命令参数
0参数
WorkingDir容器内工作目录
Env环境变量
0环境变量
Name环境变量名称
Value环境变量值
Resources容器资源
Limits资源限制
:
Requests资源需求
:
LifecycleLifecycle对象
PreStop容器停止之前
Exec执行对象
Command命令
0
PostStart容器启动之后
Exec执行对象
Command命令
0
SharedVolumeMountPaths容器间共享的本地目录
0共享的本地目录
PodLabelsPod标签
:
ResourceConfig资源配置
CPUCPU核心数
GPUGPU核心数
Memory内存容量
SharedMemory共享内存容量
GPUTypeGPU类型
UseSpotInstance是否使用竞价实例
请选择布尔值
SpotSpec抢占式实例配置
SpotStrategy抢占式实例抢占策略
SpotDiscountLimit抢占式实例最高价格折扣上限
SpotPriceLimit抢占式实例最高价格上限
AssignNodeSpec指定调度节点详情
EnableAssignNodeEnableAssignNode
请选择布尔值
NodeNamesNodeNames
AntiAffinityNodeNamesAntiAffinityNodeNames
UserCommand任务所有节点的启动命令
DataSources任务运行所使用的数据源列表
0本任务使用的所有数据源列表
DataSourceId数据源的ID
MountPath本任务需要挂载的路径
Uri数据源路径
Options自定义数据集挂载属性
DataSourceVersion
CodeSource本任务使用的代码源
CodeSourceId代码源ID
Branch本任务运行时
Commit本任务需要下载的代码Commit ID
MountPath本次任务需要挂载的路径
UserVpc用户VPC配置
VpcId用户VPC的ID
SwitchId用户交换机的ID
SecurityGroupId用户安全组的ID
ExtendedCIDRs扩展网段
0扩展网段
DefaultRoute默认路由
ThirdpartyLibs待安装的Python三方库列表
0指定一个第三方Python库和对应版本要求
ThirdpartyLibDirPython三方库(requireme...
Envs环境变量配置
:
JobMaxRunningTimeMinutes作业最长运行时长
WorkspaceId工作空间ID
ResourceId资源组ID
Priority任务的优先级
Settings额外参数配置
BusinessUserId作业关联用户ID
Caller调用方
Tags自定义标签
:
PipelineId工作流ID
EnableTideResource允许任务使用潮汐资源
请选择布尔值
EnableErrorMonitoringInAIMaster允许作业开启容错监控
请选择布尔值
ErrorMonitoringArgs启用容错监控后
EnableRDMA允许作业使用RDMA
请选择布尔值
EnableOssAppend是否允许OSS追加写
请选择布尔值
OversoldType作业的超卖资源使用方式(不接受/可接受...
AdvancedSettings额外高级参数配置
DriverNVIDIA驱动配置
EnableSanityCheck允许作业开启算力健康检测
请选择布尔值
SanityCheckArgs算力健康检测的配置参数
JobReservedMinutes作业结束后保留的时长(分钟)
JobReservedPolicy作业结束后保留的策略
EnableCPUAffinityCPU亲和性设置
请选择布尔值
DisableEcsStockCheck是否跳过库存校验
请选择布尔值
ElasticSpec该参数暂未支持
EnableElasticTraining打开弹性训练
请选择布尔值
MinParallelism最小并行度
MaxParallelism最大并行度
AIMasterTypeaimaster角色使用的资源规格
AIMasterDockerImageaimaster docker镜像
EnablePsJobElasticWorker是否开启弹性Worker对于PS作业
请选择布尔值
EnableAIMaster是否打开AIMaster
请选择布尔值
EnablePsResourceEstimate是否打开PS资源预估
请选择布尔值
EnablePsJobElasticPS是否打开弹性PS功能
请选择布尔值
PSMinParallelismPS最小并行度
PSMaxParallelismPS最大并行度
ElasticStrategy弹性训练策略
EnableEDP是否打开EDP
请选择布尔值
EDPMaxParallelismEDP最大并行度
EDPMinParallelismEDP最小并行度
DebuggerConfigContent该参数暂未支持
Options本任务的额外配置
SuccessPolicy分布式多机任务的成功策略
CredentialConfig访问凭证配置
EnableCredentialInjectEnableCredentialInject
请选择布尔值
AliyunEnvRoleKeyAliyunEnvRoleKey
CredentialConfigItemsCredentialConfigItems
0A short description...
KeyKey
TypeType
RolesRoles
0A short description...
RoleArnRoleArn
RoleTypeRoleType
AssumeRoleForAssumeRoleFor
PolicyPolicy
AssumeUserInfoA short description...
SecurityTokenSecurityToken
AccessKeyIdAccessKeyId
TypeType
IdId
Accessibility作业的可见性
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

请求语法

POST /api/v1/jobs HTTP/1.1

请求参数

字段名称字段详情
bodyobject

请求 Body 参数。

返回参数

字段名称字段详情
JobIdstring

此次调用创建的任务 ID。

示例值:dlc7*******
RequestIdstring

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

示例值:473469C7-AA6F-4DC5-B3DB-xxxxxxx
变更历史
变更时间变更内容概要操作
2024-12-18
变更请求参数body
2024-08-09
变更请求参数body
2024-07-05
变更请求参数body
2023-12-08
变更请求参数body
2023-09-11
变更请求参数body
2022-12-13
变更请求参数body