更新作业 - UpdateJob
功能介绍
更新作业。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
tasks | 是 | Array of JobTaskDto objects | 参数解释: 作业子步骤。 约束限制: 子步骤个数取值范围为[0,64]。 取值范围: busheji 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
task_name | 是 | String | 参数解释: 子任务实际名称。 约束限制: 不涉及 取值范围: 长度[1,32],只能以大小写字母开头,由大小写字母、数字、中划线(-)、下划线(_)组成,以大小写字符或数字结尾。 默认取值: 不涉及 |
inputs | 否 | Array of TaskParameterDto objects | 参数解释: 任务的输入参数信息。 约束限制: 最多支持128个参数。 取值范围: 不涉及 默认取值: 不涉及 |
outputs | 否 | Array of TaskParameterDto objects | 参数解释: 任务的输出参数信息。 约束限制: 最多支持128个参数。 取值范围: 不涉及 默认取值: 不涉及 |
resources | 否 | TaskResourceDto object | 参数解释: 应用申请资源。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
output_dir | 否 | String | 参数解释: 子任务结果存储目录,默认为空。 约束限制: 不涉及 取值范围: 长度[0,128]。 默认取值: 不涉及 |
io_acc_type | 否 | String | 参数解释: 子任务使用的IO加速实例类型,不填表示不使用。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 是 | String | 参数解释: 子任务的参数名称。 约束限制: 不涉及 取值范围: 长度为[1,32],以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。需要和已有应用的参数名称一致。 默认取值: 不涉及 |
source | 否 | String | 参数解释: 子任务的参数类型。 约束限制: 不涉及 取值范围:
默认取值: MANUAL |
values | 否 | Array of strings | 参数解释: 子任务的参数数值。 约束限制: 每个参数取值范围[0,2048],最多支持设置128个参数。 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
cpu | 否 | String | 参数解释: cpu申请使用量。 约束限制: 不涉及 取值范围: 取值范围[0.1-128],单位C,支持一位小数。对于应用,不填默认1C;对于流程和作业,不填默认使用前一级的配置,填值会覆盖更新。覆盖关系:作业->流程->应用。 默认取值: 不涉及 |
cpu_type | 否 | String | 参数解释: cpu架构类型。 约束限制: 不涉及 取值范围: 取值范围,支持X86|ARM。 默认取值: X86。 |
memory | 否 | String | 参数解释: 内存申请使用量。 约束限制: 不涉及 取值范围: 取值范围[0.1-3072],单位G,支持一位小数。对于应用,不填默认1G;对于流程和作业,不填默认使用前一级的配置,填值会覆盖更新。覆盖关系:作业->流程->应用。 默认取值: 不涉及 |
gpu_type | 否 | String | 参数解释: gpu架构类型。 约束限制: 不涉及 取值范围: gpu架构类型,支持GPU|Snt9。对于流程和作业,不填默认使用前一级的配置,填值会覆盖更新。覆盖关系:作业->流程->应用。 默认取值: 不涉及 |
gpu | 否 | String | 参数解释: gpu申请使用量。 约束限制: 不涉及 取值范围: 取值范围[0-16],仅支持整数。对于流程和作业,不填默认使用前一级的配置,填值会覆盖更新。覆盖关系:作业->流程->应用。 默认取值: 不涉及 |
响应参数
状态码:202
ACCEPTED
无
请求示例
更新作业,更新作业的cpu资源为1C,内存资源为1G。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/update
{
"tasks" : [ {
"task_name" : "app1-1",
"inputs" : [ {
"name" : "dir-parameter",
"source" : "MANUAL",
"values" : [ "test-project:/300M_NA12878_clean_1.fastq" ]
} ],
"outputs" : [ {
"name" : "dir-parameter",
"source" : "MANUAL",
"values" : [ "test-project:/output-dir/" ]
} ],
"resources" : {
"cpu" : "1C",
"cpu_type" : "X86",
"memory" : "1G",
"gpu_type" : "GPU",
"gpu" : 0
},
"io_acc_type" : "SFS"
} ]
} 响应示例
无
状态码
状态码 | 描述 |
|---|---|
202 | ACCEPTED |
错误码
请参见错误码。

