作业相关操作

最近更新时间:2019-08-12 20:21:15

启动简单作业(StartSimpleJob)

1. 命令描述

启动简单作业。

2. 输入参数

参数名称 必选 类型 描述
name String 项目名称,仅限“中文”、“英文”或“数字”
projectId String 项目 ID
secretId String 腾讯云 secretId
secretKey String 腾讯云 secretKey
imgId String 镜像 ID
name String 作业名称,默认为 default_job
desc String 作业描述
cmd String 执行命令行
instanceType String CVM 机型
rootPassword String CVM 登录密码,默认为 HelixRoot2017
dataDiskSize String 数据盘大小,默认为 0GB
vpcid String 私有网络 ID
subnetid String 私有网络子网 ID,跟 vpcid 联合起作用
extMountPath String 本地目录和 COS 目录的映射
extOutputPath String 本地输出目录和 COS 目录的映射
priority Int 作业优先级,取值 1-100,默认 100
timeout String 任务执行超时时间,单位秒 s,小时 h,天 d,例如 1h
zone String 资源可用区域,默认为对应地域2区(ap-guangzhou-2,ap-shanghai-2,ap-beijing-2),如果有指定 vpc 的信息,以 vpc 的区域为准
dataDiskPath String 数据盘挂载地址,默认 /helixdata/
projectLocalPath String 工程挂载地址,默认 /helixproject/

extMountPath,extOutputPath格式描述如下,多个路径挂载以逗号分开。
cos://bucket-appId.cosregion.myqcloud.com/cos_uri:/helixdata/myoutput

双螺旋系统会自动把申请的数据盘挂载到 /helixdata/ 下,建议输出目录挂载到 /helixdata/ 下保证输出 buffer 够用。

注意:

在启动作业时,系统会自动把工程的主目录挂载到 /helixproject/ 目录下,对此目录的读写会直接同步到工程中,其中 stdout 和 stderr 为系统目录,保存了系统运行时标准输出和标准错误的信息。

3. 输出参数

参数名称 类型 描述
code Int 错误码。0:成功;其他值:失败
message String 错误信息
data Struct 返回数据

Data结构

参数名称 类型 描述
projectId String 项目 ID

拉取简单作业列表(ListSimpleJob)

1. 命令描述

拉取简单作业列表。需要填入指定的项目 ID。

2. 输入参数

参数名称 必选 类型 描述
projectId String 项目 ID

3. 输出参数

参数名称 类型 描述
code Int 错误码。0:成功;其他值:失败
message String 错误信息
data Struct 返回数据

Data 结构

参数名称 类型 描述
totalCount int 总作业数
list Array 返回数组

List 结构说明

参数名称 类型 描述
jobId String 作业 ID
status String 作业状态
startTime String 作业开始时间
endTime String 作业结束时间
desc String 作业描述

作业状态说明:

作业状态 描述
Accepted 作业已接受,但尚未运行
Running 作业正在运行
Failed 作业运行失败
Succeed 作业运行成功
Suspend 作业暂停,可能的原因是资源不够,或是较长时间未调度
Cancelled 用户取消作业

查询作业信息(QuerySimpleJob)

1. 命令描述

查询简单作业信息。

2. 输入参数

参数名称 必选 类型 描述
projectId String 项目 ID
jobId String 任务 ID

3. 输出参数

参数名称 类型 描述
code Int 错误码。0:成功;其他值:失败
message String 错误信息
data Struct 返回数据

Data 结构

参数名称 类型 描述
status String 作业状态
startTime String 作业开始时间
endTime String 作业结束时间
name String 作业名称
desc String 作业描述
deviceDetailUrl String 设备监控管理地址
deviceId String 设备 ID
sysmsg String 一些系统错误或者警告提示信息

取消作业(CancelJob)

1. 命令描述

取消正在进行的作业。

2. 输入参数

参数名称 必选 类型 描述
projectId String 项目 ID
jobId String 任务 ID

3. 输出参数

参数名称 类型 描述
code Int 错误码。0:成功;其他值:失败
message String 错误信息

删除作业(DelJob)

1. 命令描述

删除作业。只允许删除状态为 success/failed/stopped 的 Task。

2. 输入参数

参数名称 必选 类型 描述
projectId String 项目 ID
jobId String 任务 ID

3. 输出参数

参数名称 类型 描述
code Int 错误码。0:成功;其他值:失败
message String 错误信息