更新时间:2025-12-23 GMT+08:00
分享

获取作业列表 - ListJob

功能介绍

获取作业列表。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

是

String

参数解释:

空间ID,您可以从获取空间ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

project_id

是

String

参数解释:

项目ID,您可以从获取项目ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

end_time

否

Long

参数解释:

最大开始时间。

约束限制:

不涉及

取值范围:

取值范围为[1000000000000-9999999999999]

默认取值:

不涉及

job_name

否

String

参数解释:

作业名称。

约束限制:

不涉及

取值范围:

以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。取值范围为[1,128]。

默认取值:

不涉及

types

否

Array of strings

参数解释:

作业类型列表。

约束限制:

作业类型当前仅支持app和workflow,最多同时查询2种作业类型。

取值范围:

  • app:应用作业

  • workflow:流程作业

默认取值:

不涉及

labels

否

Array of strings

参数解释:

标签列表。

约束限制:

仅支持中文、英文、数字、中划线和下划线,长度为[1-32]个字符。最多设置5个标签。

取值范围:

不涉及

默认取值:

不涉及

limit

否

Integer

参数解释:

限制量,单次查询总量。

约束限制:

不涉及

取值范围:

取值范围[1,1000]。

默认取值:

默认为100

offset

否

Integer

参数解释:

偏移量,查询起始偏移。

约束限制:

不涉及

取值范围:

取值范围[0,100000000]。

默认取值:

默认为0

sort_dir

否

String

参数解释:

排序规则。

约束限制:

不涉及

取值范围:

  • DESC:降序。

  • ASC:升序。

默认取值:

DESC

sort_key

否

String

参数解释:

排序字段。

约束限制:

不涉及

取值范围:

  • status:状态。

  • tool_name:应用或流程名称。

  • total_time:总耗时。

  • name:作业名称

  • user_name:作业创建者。

  • create_time:作业创建时间。

  • finish_time:作业结束时间。

默认取值:

不涉及

start_time

否

Long

参数解释:

最小开始时间。

约束限制:

不涉及

取值范围:

取值范围为[1000000000000-9999999999999]

默认取值:

不涉及

status_list

否

Array of strings

参数解释:

作业运行状态列表。

约束限制:

最多支持同时查询10种状态。

取值范围:

  • Succeeded:成功

  • Running:运行中

  • Pending:等待中

  • Failed:失败

  • Cancelling:取消中

  • Cancelled:已取消

  • Unknown:未知

默认取值:

不涉及

tool_name

否

String

参数解释:

作业依赖的组件名称(有可能是Workflow,有可能是app)。

约束限制:

不涉及

取值范围:

以小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以小写字母或数字结尾。取值范围[1,128]。

默认取值:

不涉及

user_name

否

String

参数解释:

作业创建者。

约束限制:

不涉及

取值范围:

长度为[1,128]个字符。

默认取值:

不涉及

finish_start_time

否

Long

参数解释:

最小结束时间。

约束限制:

不涉及

取值范围:

取值范围为[1000000000000-9999999999999]。

默认取值:

不涉及

finish_end_time

否

Long

参数解释:

最大结束时间。

约束限制:

不涉及

取值范围:

取值范围为[1000000000000-9999999999999]。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及

取值范围:

长度为[1-32768]个字符。

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

jobs

Array of JobListDto objects

参数解释:

作业列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

count

Integer

参数解释:

作业总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

running_count

Integer

参数解释:

运行中作业总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

waiting_count

Integer

参数解释:

等待中作业总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 JobListDto

参数

参数类型

描述

id

String

参数解释:

作业ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

作业的名称。

约束限制:

取值范围:[1,63],允许大小写字母、数字、以及特殊字符中划线(-)。

取值范围:

长度[1,63],以小写字母、大写字母或数字开头,允许出现中划线。

默认取值:

不涉及

eihealth_project_id

String

参数解释:

作业所属空间ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

eihealth_project_name

String

参数解释:

作业所属空间名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

作业的描述。

约束限制:

不涉及

取值范围:

长度最大为255个字符。

默认取值:

不涉及

labels

Array of strings

参数解释:

作业标签。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

priority

Integer

参数解释:

作业优先级。

约束限制:

取值范围[0,9],0最低,默认0。

取值范围:

长度[0,9],0最低,默认0。

默认取值:

0

timeout

Integer

参数解释:

作业执行超时时长。

约束限制:

取值范围: [1,144000],单位:分钟,默认1440。

取值范围:

长度[1,144000],单位:分钟,默认1440。

默认取值:

1440

output_dir

String

参数解释:

作业结果存储目录,默认为空,表示使用自身项目桶的根目录。

约束限制:

不涉及

取值范围:

长度[0,128]。

默认取值:

不涉及

status

String

参数解释:

作业状态。

约束限制:

不涉及

取值范围:

  • SUCCEEDED:成功

  • FAILED:失败

  • CANCELLED:取消

  • IN_QUEUE:等待队列中

  • UNKNOWN:未知

  • PENDING:等待中

  • RUNNING:运行中

  • RETRYING:重试中

  • CANCELLING:取消中

默认取值:

不涉及

create_time

String

参数解释:

作业创建时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

start_time

String

参数解释:

作业开始时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

finish_time

String

参数解释:

作业结束时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

failed_message

String

参数解释:

失败提示,当作业执行失败时会返回。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

failed_reason

String

参数解释:

失败原因,当作业执行失败时会返回。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

user_name

String

参数解释:

创建任务的用户名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

tool_info

ToolInfoDto object

参数解释:

作业依赖的组件信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

io_acc_id

String

参数解释:

作业使用的IO加速实例ID,不填表示不使用。

约束限制:

不涉及

取值范围:

长度[0,128],支持字母、数字、下划线和中划线。

默认取值:

不涉及

io_acc_expected_usage

Integer

参数解释:

作业使用的SFS-Turbo实例预期占用存储量,单位G,用于投递作业时评估当前加速实例余量是否充足。

约束限制:

不涉及

取值范围:

长度[0,327680]。

默认取值:

不涉及

still_running_tasks

Array of strings

参数解释:

仍在运行中的子任务。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 ToolInfoDto

参数

参数类型

描述

tool_id

String

参数解释:

作业依赖的组件ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

tool_name

String

参数解释:

作业依赖的组件名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

tool_version

String

参数解释:

作业依赖的组件版本。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

tool_type

String

参数解释:

作业依赖的组件类型。

约束限制:

不涉及

取值范围:

  • app:应用类型

  • workflow:流程类型

默认取值:

不涉及

请求示例

查询作业列表。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs

响应示例

状态码: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

错误码

请参见错误码。

相关文档