文档首页/ AI科学计算服务/ API参考/ API/ 数据管理/ 数据作业管理/ 获取数据作业列表
更新时间：2025-07-08 GMT+08:00
查看PDF
分享

获取数据作业列表

功能介绍

获取数据作业列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

是

String

参数解释：

空间ID，您可以在平台单击所需的空间名称，进入空间设置页面查看。

约束限制：

不涉及

取值范围：

仅支持中英文字符串、中划线和下划线，长度为[1-128]个字符。

默认取值：

不涉及

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

仅支持中英文字符串、中划线和下划线，长度为[1-128]个字符。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

creator

否

String

参数解释：

创建者名称。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

from_time

否

Long

参数解释：

查询该时间之后创建的数据作业。

约束限制：

不涉及

取值范围：

时间戳，范围为[1000000000000-9999999999999]。

默认取值：

不涉及

limit

否

Integer

参数解释：

查询条数。

约束限制：

不涉及

取值范围：

整数，范围为[1-1000]。

默认取值：

100

name

否

String

参数解释：

数据作业名称。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

offset

否

Integer

参数解释：

查询偏移量。

约束限制：

不涉及

取值范围：

整数，范围为[0-100000000]。

默认取值：

0

status

否

String

参数解释：

数据作业状态。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

to_time

否

Long

参数解释：

查询该时间之前创建的数据作业。

约束限制：

不涉及

取值范围：

时间戳，范围为[1000000000000-9999999999999]。

默认取值：

不涉及

type

否

String

参数解释：

数据作业类型。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

finish_from_time

否

Long

参数解释：

查询该时间之后完成的数据作业。

约束限制：

不涉及

取值范围：

时间戳，范围为[1000000000000-9999999999999]。

默认取值：

不涉及

finish_to_time

否

Long

参数解释：

查询该时间之前完成的数据作业。

约束限制：

不涉及

取值范围：

时间戳，范围为[1000000000000-9999999999999]。

默认取值：

不涉及

sort_dir

否

String

参数解释：

排序规则。

约束限制：

不涉及

取值范围：

  • asc：升序

  • desc：降序

默认取值：

desc

sort_key

否

String

参数解释：

排序规则，目前默认时间降序，支持根据status，name，type，creator，create_time，end_time。

约束限制：

不涉及

取值范围：

  • status：状态

  • name：作业名称

  • type：作业类型

  • creator：创建者

  • create_time：创建时间

  • end_time：结束时间

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

总条数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

data_jobs

Array of DataJobRsp objects

参数解释：

数据作业列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表5 DataJobRsp

参数

参数类型

描述

creator

String

参数解释：

数据作业创建者。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

end_time

String

参数解释：

数据作业结束时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

id

String

参数解释：

数据作业ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

数据作业名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_time

String

参数解释：

数据作业创建时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

status

String

参数解释：

数据作业状态。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

finish_count

Integer

参数解释：

数据作业完成数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

total_count

Integer

参数解释：

数据作业总数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

type

String

参数解释：

数据作业类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

failed_reason

String

参数解释：

数据作业失败原因。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

additions

String

参数解释：

附加信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

获取数据作业列表。

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

响应示例

状态码：200

OK

{
  "count" : 30,
  "data_jobs" : [ {
    "creator" : "creator",
    "end_time" : "2021-04-21T09:30:37Z",
    "id" : "94116a6b-1945-4581-b64c-2cea712988ab",
    "name" : "DataDelete-20210421093037",
    "create_time" : "2021-04-21T09:30:37Z",
    "status" : "SUCCEED",
    "finish_count" : 4,
    "total_count" : 10,
    "type" : "DELETE_DATA"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 数据作业管理

相关文档