查询即时任务列表
调试
您可以在API Explorer中调试该接口。
URI
- URI格式
GET /v3/{project_id}/tasklist?offset={offset}&limit={limit}&id={id}&instance_id={instance_id}&order_id={order_id}&name={name}&status={status}&start_time={start_time}&end_time={end_time}
- 参数说明
表1 参数说明 名称
是否必选
参数类型
说明
project_id
是
String
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
offset
否
Integer
参数解释：
索引位置，偏移量。
约束限制：
不涉及。
取值范围：
从第一条数据偏移offset条数据后开始查询，必须为数字，不能为负数。
默认取值：
默认为0。偏移0条数据，表示从第一条数据开始查询。
limit
否
Integer
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
不能为负数，最小值为1，最大值为50。
默认取值：
10
id
否
String
参数解释：
任务ID，按照任务ID过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
否
String
参数解释：
实例ID，按照实例ID过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
order_id
否
String
参数解释：
订单ID，按照订单ID过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
name
否
String
参数解释：
任务名称，按照任务名称过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
status
否
String
参数解释：
任务状态，按任务状态过滤。
约束限制：
不涉及。
取值范围：
- Running：运行中。
- Completed：已完成。
- Failed：已失败。
默认取值：
不涉及。
start_time
否
String
参数解释：
任务的创建时间，按时间范围进行过滤。
约束限制：
“start_time”有值时，“end_time”必选。格式为UTC时间戳。
取值范围：
不涉及。
默认取值：
不涉及。
end_time
否
String
参数解释：
任务的结束时间，按时间范围进行过滤。
约束限制：
“start_time”有值时，“end_time”必选。格式为UTC时间戳。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
无。
请求示例
GET https://{Endpoint}/v3/54623db08b174c858ba779d2aa7923a3/tasklist?offset=1&limit=3&start_time=1747919701390&end_time=1748524501390
响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
total_count
Integer
参数解释：
总任务数量。
取值范围：
不涉及。
actions
Array of strings
参数解释：
任务名称列表。
取值范围：
不涉及。
tasks
Array of objects
参数解释：
任务列表。请参见表3。
表3 tasks字段说明 参数
参数类型
描述
id
String
参数解释：
任务ID。
取值范围：
不涉及。
name
String
参数解释：
任务名称。
取值范围：
不涉及。
instance_id
String
参数解释：
实例ID。
取值范围：
不涉及。
instance_name
String
参数解释：
实例名称。
取值范围：
不涉及。
instance_status
String
参数解释：
实例状态。
取值范围：
- 值为“BUILD”，表示实例正在创建。
- 值为“CREATE FAIL”，表示实例创建失败。
- 值为“ACTIVE”，表示实例正常。
- 值为“FAILED”，表示实例异常。
- 值为“FROZEN”，表示实例冻结。
- 值为“MODIFYING”，表示实例正在扩容。
- 值为“REBOOTING”，表示实例正在重启。
- 值为“RESTORING”，表示实例正在恢复。
- 值为“MODIFYING INSTANCE TYPE”，表示实例正在转主备。
- 值为“SWITCHOVER”，表示实例正在主备切换。
- 值为“MIGRATING”，表示实例正在迁移。
- 值为“BACKING UP”，表示实例正在进行备份。
- 值为“MODIFYING DATABASE PORT”，表示实例正在修改数据库端口。
- 值为“STORAGE FULL”，表示实例磁盘空间满。
order_id
String
参数解释：
订单ID。
取值范围：
不涉及。
process
String
参数解释：
任务进度，单位百分比。
取值范围：
0~100。当任务成功或者失败状态下，该值为空字符串。
fail_reason
String
参数解释：
失败原因。
取值范围：
不涉及。
create_time
String
参数解释：
任务创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
取值范围：
不涉及。
end_time
String
参数解释：
任务计划结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
取值范围：
不涉及。
status
String
参数解释：
任务状态。
取值范围：
- Running：运行中。
- Completed：已完成。
- Failed：已失败。
- 正常响应样例
{ "tasks" : [ { "id" : "676e9f17f9b74289883a44a47b8101f5", "name" : "RestoreSqlserverInInstance", "instance_id" : "4d00c7e9d22145deb889937a72b59c8ein01", "instance_name" : "rds-local-scale", "instance_status" : "FAILED", "order_id" : "CS2506041000FOJXC", "process" : "", "create_time" : "2020-07-15T07:46:10+0000", "end_time" : "2020-07-15T09:46:10+0000", "status" : "Completed" } ], "actions" : [ "RestoreSqlserverInInstance" ], "total_count" : 1 } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
