查询定时任务列表
调试
您可以在API Explorer中调试该接口。
URI
- URI格式
GET /v3/{project_id}/schedule-tasks?offset={offset}&limit={limit}&instance_name={instance_name}&instance_id={instance_id}&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
instance_id
否
String
参数解释：
实例ID，按照实例ID过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_name
否
String
参数解释：
实例名称，按照实例名称过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
status
否
String
参数解释：
任务状态，按任务状态过滤。
约束限制：
不涉及。
取值范围：
- Initing：初始化中。
- Pending：挂起。
- Running：运行中。
- Completed：已完成。
- Failed：已失败。
- Unauthorized：未授权。
- Canceled：已取消。
默认取值：
不涉及。
start_time
否
String
参数解释：
查询任务创建的开始时间。
约束限制：
“start_time”有值时，“end_time”必选。格式为UTC时间戳。
取值范围：
不涉及。
默认取值：
不涉及。
end_time
否
String
参数解释：
查询任务创建的结束时间。
约束限制：
“start_time”有值时，“end_time”必选。格式为UTC时间戳。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
无。
请求示例
GET https://{Endpoint}/v3/54623db08b174c858ba779d2aa7923a3/schedule-tasks?offset=1&limit=3&instance_id=43e4feaab48f11e89039fa163ebaa7e4in04&instance_name=sqlserver_instance&start_time=1747919701390&end_time=1748524501390
响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
schedule_tasks
Array of objects
参数解释：
定时任务列表。请参见表3。
total_count
Integer
参数解释：
总任务数量。
取值范围：
不涉及。
表3 schedule_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”，表示实例磁盘空间满。
project_id
String
参数解释：
项目ID。
取值范围：
不涉及。
create_time
String
参数解释：
任务创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
取值范围：
不涉及。
start_time
String
参数解释：
任务计划开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
取值范围：
不涉及。
end_time
String
参数解释：
任务计划结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
取值范围：
不涉及。
order
String
参数解释：
任务优先级。
取值范围：
1~100的整数，数值越小优先级越高。
status
String
参数解释：
任务状态。
取值范围：
- Initing：初始化中。
- Pending：挂起。
- Running：运行中。
- Completed：已完成。
- Failed：已失败。
- Unauthorized：未授权。
- Canceled：已取消。
- Deleted：已删除。
datastore_type
String
参数解释：
数据库类型。
取值范围：
不涉及。
volume_type
String
参数解释：
磁盘类型。
取值范围：
不涉及。
target_config
object
参数解释：
目标配置。请参见表4。
- 正常响应样例
{ "schedule_tasks" : [ { "id" : "5ed6a9e95f2747f7bac1b5899ddd1316", "instance_id" : "3d2929b2c7ea4fe9bd27f21061d037ccin01", "instance_name" : "rds-zfs-test-56-44", "instance_status" : "ACTIVE", "project_id" : "54623db08b174c858ba779d2aa7923a3", "name" : "RESIZE_FLAVOR", "create_time" : "2020-07-15T07:46:10+0000", "start_time" : "2020-07-15T08:46:10+0000", "end_time" : "2020-07-15T09:46:10+0000", "order" : "1", "status" : "Canceled", "datastore_type" : "mysql", "target_config" : { "flavor" : "rds.mysql.n1.xlarge.2", "mem" : "8", "cpu" : "4" }, "volume_type" : "CLOUDSSD" } ], "total_count" : 1 } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
