获取作业列表
功能介绍
获取作业列表
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
eihealth_project_id |
是 |
String |
平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 |
|
project_id |
是 |
String |
华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
end_time |
否 |
Long |
最大开始时间 |
|
job_name |
否 |
String |
作业名称 取值范围：长度为[1,63]，以小写字母开头，允许出现中划线(-)、小写字母和数字，且必须以小写字母或数字结尾。 最小长度：1 最大长度：128 |
|
labels |
否 |
Array |
标签列表 最小长度：1 最大长度：32 数组长度：0 - 5 |
|
limit |
否 |
Integer |
限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000] 最小值：1 最大值：1000 缺省值：100 |
|
offset |
否 |
Integer |
偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000] 最小值：0 最大值：100000000 缺省值：0 |
|
sort_dir |
否 |
String |
排序规则 目前默认时间降序 缺省值：DESC |
|
sort_key |
否 |
String |
排序规则 目前默认时间降序，支持根据status |
|
start_time |
否 |
Long |
最小开始时间 |
|
status |
否 |
String |
作业运行状态 取值（Succeeded|Running|Pending|Failed|Cancelling|Cancelled|Unknown） |
|
tool_name |
否 |
String |
作业依赖的组件名称(有可能是Workflow，有可能是app), 取值范围：长度为[1,56]，以小写字母开头，允许出现中划线(-)、小写字母和数字，且必须以小写字母或数字结尾。 最小长度：1 最大长度：128 |
|
user_name |
否 |
String |
作业创建者 最小长度：1 最大长度：128 |
|
finish_start_time |
否 |
Long |
最小结束时间 |
|
finish_end_time |
否 |
Long |
最大结束时间 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
jobs |
Array of JobListDto objects |
作业列表 |
|
count |
Integer |
作业总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
作业id |
|
name |
String |
作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-) |
|
description |
String |
作业的描述,取值范围：输入字符最大长度为255 |
|
labels |
Array of strings |
作业标签 |
|
priority |
Integer |
作业优先级，[0,9]，0表示最低，默认0 |
|
timeout |
Integer |
作业执行超时时长，取值范围: [1, 144000]，单位：分钟，默认数值1440 最小值：1 最大值：144000 |
|
output_dir |
String |
job结果存储目录，不指定则在workflow的工作目录下生产job同名子目录，指定则已指定路径为准 |
|
status |
String |
作业状态 |
|
create_time |
String |
作业创建时间 |
|
finish_time |
String |
作业结束时间 |
|
failed_message |
String |
失败提示，当作业执行失败时会返回 |
|
failed_reason |
String |
失败原因，当作业执行失败时会返回 |
|
user_name |
String |
创建任务的用户名称 |
|
tool_info |
ToolInfoDto object |
作业依赖的组件信息 |
|
io_acc_id |
String |
作业使用的IO加速实例id，不填表示不使用； |
|
io_acc_expected_usage |
Integer |
作业使用的SFS-Turbo实例预期占用存储量，单位G，用于投递作业时评估当前加速实例余量是否充足 |
|
still_running_tasks |
Array of strings |
仍在运行中的子任务 |
请求示例
无
响应示例
状态码： 200
OK
{
"jobs" : [ {
"id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"name" : "demo-job",
"description" : "description",
"priority" : 0,
"timeout" : 1440,
"output_dir" : "/job",
"status" : "SUCCEEDED",
"create_time" : "2021-01-30T02:34:36Z",
"finish_time" : "2021-01-30T02:53:26Z",
"user_name" : "gwj-test-01",
"tool_info" : {
"tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"tool_name" : "demo-workflow",
"tool_version" : "1.0.0",
"tool_type" : "workflow"
},
"still_running_tasks" : [ "task1", "task2" ]
} ],
"count" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
