查询任务列表和详情
接口说明
根据指定条件查询任务中心中的任务列表和详情。
约束说明
- 目前只支持查询DDS社区版任务中心一个月内的异步任务。
|
名称 |
类型 |
IN |
是否必选 |
描述 |
|---|---|---|---|---|
|
project_id |
string |
path |
是 |
租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
start_time |
是 |
String |
查询开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始,Z指时区偏移量 |
|
end_time |
是 |
String |
查询结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间,时间跨度不超过30天。 其中,T指某个时间的开始,Z指时区偏移量。 |
|
status |
否 |
String |
任务状态:取值为“Running”为执行中;取值为“Completed”为完成;取值为“Failed”为失败。 |
|
id |
否 |
String |
任务ID。 |
|
name |
否 |
String |
任务名称。对应取值如下:
|
|
offset |
否 |
Integer |
索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 |
|
limit |
否 |
Integer |
查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 |
请求参数
|
名称 |
类型 |
IN |
是否必选 |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
string |
header |
是 |
用户Token。 |
响应参数
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
jobs |
Array of 表5-5 objects |
任务列表。 |
|
total_count |
Integer |
任务列表总数。 |
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
id |
String |
任务ID。 |
|
name |
String |
任务名称。 |
|
instance_id |
String |
实例ID。 |
|
instance_name |
String |
实例名称。 |
|
status |
String |
任务状态。取值为“Running”为执行中;取值为“Completed”为完成;取值为“Failed”为失败。 |
|
progress |
String |
任务执行进度。
说明:
执行中状态才返回执行进度,例如“60%”,表示任务执行进度为60%,否则返回“”。任务执行进度。 |
|
fail_reason |
String |
任务执行失败时的错误信息。 |
|
created_at |
String |
创建时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
|
ended_at |
String |
结束时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
- 响应示例
{ "jobs": [ { "id": "2f406db7-bdc4-402f-9dc4-2c1b094a5f93", "name": "RestartReplicaSetInstance", "status": "Completed", "created_at": "2022-09-05T06:24:14+0000", "ended_at": "2022-09-05T06:25:43+0000", "progress": "", "instance_id": "1f311e6a299345d7bbc878874844e233in02", "instance_name": "dds-6be2-fwyrestore", "fail_reason": "" } ] }
状态码
详情请参见状态码。
错误码
详情请参见错误码。