更新时间:2024-05-09 GMT+08:00
分享

获取数据作业列表

功能介绍

获取数据作业列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

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

排序规则 目前默认时间降序

缺省值:desc

sort_key

String

排序规则 目前默认时间降序,支持根据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://eihealth.cn-north-4.myhuaweicloud.com/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

错误码

请参见错误码

相关文档