获取作业详情
功能介绍
获取作业详情。
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
eihealth_project_id |
是 |
String |
参数解释: 空间ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
|
job_id |
是 |
String |
参数解释: 作业ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
|
X-Addition-Info |
否 |
String |
参数解释: 设置为LOG时,返回作业日志链接。 约束限制: 不涉及 取值范围: 仅支持LOG或不填值。 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 作业ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
name |
String |
参数解释: 作业的名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
user_name |
String |
参数解释: 作业的创建者。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
description |
String |
参数解释: 作业的描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
labels |
Array of strings |
参数解释: 作业标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
priority |
Integer |
参数解释: 作业的优先级。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
timeout |
Integer |
参数解释: 作业执行超时时长。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
output_dir |
String |
参数解释: 作业运行的实际的输出路径配置。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
status |
String |
参数解释: 作业运行状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
create_time |
String |
参数解释: 作业创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
start_time |
String |
参数解释: 作业开始时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
finish_time |
String |
参数解释: 作业完成时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
failed_message |
String |
参数解释: 作业运行失败描述信息,当作业执行失败时会返回。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
failed_reason |
String |
参数解释: 作业运行失败原因,当作业执行失败时会返回。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
tool_info |
ToolInfoDto object |
参数解释: 作业依赖的组件信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
tasks |
Array of TaskDefinitionDto objects |
参数解释: 作业子任务列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
task_runtime_info |
Array of TaskRuntimeDto objects |
参数解释: 作业子步骤的运行信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
dag |
Map<String,Map<String,String>> |
参数解释: 作业子步骤的依赖关系。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
io_acc_expected_usage |
Integer |
参数解释: 作业使用的SFS-Turbo实例预期占用存储量,单位G,用于投递作业时评估当前加速实例余量是否充足。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
io_acc_info |
IoAccInfoDto object |
参数解释: 作业的描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
node_labels |
Array of strings |
参数解释: 计算节点标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
still_running_tasks |
Array of strings |
参数解释: 仍在运行中的子任务。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
tool_id |
String |
参数解释: 作业依赖的组件ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
tool_name |
String |
参数解释: 作业依赖的组件名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
tool_version |
String |
参数解释: 作业依赖的组件版本。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
tool_type |
String |
参数解释: 作业依赖的组件类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_name |
String |
参数解释: 子任务实际名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
display_name |
String |
参数解释: 流程的子任务展示名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
output_dir |
String |
参数解释: 子任务的输出存放路径。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
whole_output_dir |
String |
参数解释: 子任务的完整输出路径,查看流程不会返回,查看作业时才会返回完整输出路径。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
io_acc_type |
String |
参数解释: 子任务使用的IO加速类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
resources |
TaskResourceDto object |
参数解释: 子任务对应资源信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
location |
VertexLocationDto object |
参数解释: 子任务的画布位置信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
inputs |
Array of TaskParameterDto objects |
参数解释: 子任务的输入参数信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
outputs |
Array of TaskParameterDto objects |
参数解释: 子任务的输出参数信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_info |
AppInfoDto object |
参数解释: 子任务的应用信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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],仅支持整数。对于流程和作业,不填默认使用前一级的配置,填值会覆盖更新。覆盖关系:作业->流程->应用。 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
x |
Double |
参数解释: 子任务的画布横坐标。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
y |
Double |
参数解释: 子任务的画布纵坐标。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 子任务的参数名称。 约束限制: 不涉及 取值范围: 长度为[1,32],以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。需要和已有应用的参数名称一致。 默认取值: 不涉及 |
|
source |
String |
参数解释: 子任务的参数类型。 约束限制: 不涉及 取值范围:
默认取值: MANUAL |
|
values |
Array of strings |
参数解释: 子任务的参数数值。 约束限制: 每个参数取值范围[0,2048],最多支持设置128个参数。 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
app_id |
String |
参数解释: 应用ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_name |
String |
参数解释: 应用名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_version |
String |
参数解释: 应用版本。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_src_project_name |
String |
参数解释: 应用来源项目名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_labels |
Array of strings |
参数解释: 应用标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_summary |
String |
参数解释: 应用简述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_description |
String |
参数解释: 应用描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_image |
String |
参数解释: 应用镜像。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_commands |
Array of strings |
参数解释: 任务使用到的应用自带的命令信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_input_parameters |
Array of AppInputParameterDto objects |
参数解释: 任务使用到的应用自带的输入参数信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_output_parameters |
Array of AppOutputParameterDto objects |
参数解释: 任务使用到的应用自带的输出参数信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_node_labels |
Array of strings |
参数解释: 计算节点标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
app_icon |
String |
参数解释: 图标base64编码。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 参数名称,单个应用内唯一。 约束限制: 不涉及 取值范围: 长度为[1,32],以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。 默认取值: 不涉及 |
|
description |
String |
参数解释: 参数描述。 约束限制: 不涉及 取值范围: [0-255]。 默认取值: 不涉及 |
|
required |
Boolean |
参数解释: 参数是否必须。 约束限制: 不涉及 取值范围:
默认取值: false |
|
concurrent |
String |
参数解释: 参数是否开启并发。 约束限制: 不涉及 取值范围: 当前支持vars_iter并发类型,不填表示未开启并发。 默认取值: 不涉及 |
|
type |
String |
参数解释: 参数类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
pattern |
String |
参数解释: 提示用户参数填写的格式。 约束限制: 不涉及 取值范围: 取值范围:[0-64]。对于STRING类型,匹配字符串内容,比如后缀约束.fastq;对于ENUM类型,可以提示一定要在param_enum列表范围内取值;对于FILE类型,约束文件后缀类型;对于DIRECTORY类型,提示目录下需要包含哪些文件。 默认取值: 不涉及 |
|
values |
Array of strings |
参数解释: 参数取值列表。 约束限制: 最多支持设置128个参数。 取值范围: 不涉及 默认取值: 不涉及 |
|
enum |
Array of strings |
参数解释: 枚举参数的取值列表。 约束限制: 参数类型为ENUM时才需要填此字段,每个参数取值范围[0,128]。最多支持设置20个枚举参数。 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 参数名称,单个应用内唯一。 约束限制: 不涉及 取值范围: 长度为[1,32],以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。 默认取值: 不涉及 |
|
description |
String |
参数解释: 参数描述。 约束限制: 不涉及 取值范围: [0-255]。 默认取值: 不涉及 |
|
required |
Boolean |
参数解释: 参数是否必须。 约束限制: 不涉及 取值范围:
默认取值: false |
|
type |
String |
参数解释: 参数类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
pattern |
String |
参数解释: 提示用户参数填写的格式。 约束限制: 不涉及 取值范围: 取值范围:[0-64]。对于STRING类型,匹配字符串内容,比如后缀约束.fastq;对于ENUM类型,可以提示一定要在param_enum列表范围内取值;对于FILE类型,约束文件后缀类型;对于DIRECTORY类型,提示目录下需要包含哪些文件。 默认取值: 不涉及 |
|
values |
Array of strings |
参数解释: 参数取值列表。 约束限制: 最多支持128个参数。 取值范围: 不涉及 默认取值: 不涉及 |
|
enum |
Array of strings |
参数解释: 枚举参数的取值列表。 约束限制: 参数类型为ENUM时才需要填此字段,每个参数取值范围[0,128]。最多支持设置20个枚举参数。 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_name |
String |
参数解释: 作业子任务名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
create_time |
String |
参数解释: 作业子任务运行创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
finish_time |
String |
参数解释: 作业子任务运行结束时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
actual_running_time |
Integer |
参数解释: 作业子任务实际运行时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
status |
String |
参数解释: 作业子任务运行状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
sub_tasks |
Array of SubTaskRuntimeDto objects |
参数解释: 作业子任务的并发实例列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sub_task_name |
String |
参数解释: 作业子任务的并发实例名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
create_time |
String |
参数解释: 作业子任务的并发实例运行创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
finish_time |
String |
参数解释: 作业子任务的并发实例运行结束时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
actual_running_time |
Integer |
参数解释: 作业子任务的并发实例实际运行时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
status |
String |
参数解释: 作业子任务的并发实例运行状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
log_storage_link |
String |
参数解释: 作业日志存储链接。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
pod_create_time |
String |
参数解释: task的pod创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
pod_start_time |
String |
参数解释: task的pod启动时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
job_failed_times |
Integer |
参数解释: task的cce job失败次数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询作业详情。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}
响应示例
状态码:200
OK
{
"id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"name" : "demo-job",
"description" : "description",
"labels" : [ "labelA", "labelB" ],
"priority" : 0,
"timeout" : 1440,
"output_dir" : "/job/task",
"status" : "SUCCEEDED",
"create_time" : "2021-01-30T02:53:26Z",
"finish_time" : "2021-01-30T02:53:26Z",
"tool_info" : {
"tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"tool_name" : "demo-workflow",
"tool_version" : "1.0.0",
"tool_type" : "workflow"
},
"tasks" : [ {
"task_name" : "app1-1",
"display_name" : "步骤1",
"output_dir" : "/task",
"whole_output_dir" : "/workflow/task",
"io_acc_type" : "SFS",
"resources" : {
"cpu_type" : "X86",
"cpu" : "1C",
"memory" : "1G",
"gpu_type" : "GPU",
"gpu" : 0
},
"location" : {
"x" : 100,
"y" : 100
},
"inputs" : [ {
"name" : "dir-parameter",
"values" : [ "test-project:/300M_NA12878_clean_1.fastq" ]
} ],
"outputs" : [ {
"name" : "dir-parameter",
"values" : [ "test-project:/output-dir/" ]
} ],
"app_info" : {
"app_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"app_name" : "demo-app",
"app_version" : "1.0.0",
"app_labels" : [ "labelA", "labelB" ],
"app_summary" : "summary",
"app_description" : "description",
"app_image" : "gwj-test-01/busybox:latest",
"app_commands" : [ "echo eihealth;" ],
"app_input_parameters" : [ {
"name" : "dir-parameter",
"description" : "parameter description",
"required" : true,
"type" : "DIRECTORY",
"pattern" : "*.fastq",
"values" : [ "test-project:/300M_NA12878_clean_1.fastq" ],
"enum" : [ "/test" ]
} ],
"app_output_parameters" : [ {
"name" : "dir-parameter",
"description" : "parameter description",
"required" : true,
"type" : "DIRECTORY",
"pattern" : "*.fastq",
"values" : [ "test-project:/output-dir/" ]
} ]
}
} ],
"task_runtime_info" : [ {
"task_name" : "app1-1",
"create_time" : "2021-01-30T02:53:26Z",
"finish_time" : "2021-01-30T02:53:26Z",
"actual_running_time" : 100,
"status" : "SUCCEEDED",
"sub_tasks" : [ {
"sub_task_name" : "app1-1-0",
"create_time" : "2021-01-30T02:53:26Z",
"finish_time" : "2021-01-30T02:53:26Z",
"actual_running_time" : 100,
"status" : "SUCCEEDED",
"pod_create_time" : "2021-01-30T02:53:26Z",
"pod_start_time" : "2021-01-30T02:53:26Z",
"job_failed_times" : 0
} ]
} ],
"dag" : {
"app1-1" : { }
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。