# 查询定时任务列表 - ListScheduleTasks #### 功能介绍 查询定时任务列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListScheduleTasks)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:task:listAll | read | - | - | rds:task:list | - | #### 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](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。表示从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0。偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 50\] **默认取值：** 10 | | instance_id | 否 | String | **参数解释：** 实例ID，按照实例ID过滤。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_name | 否 | String | **参数解释：** 实例名称，按照实例名称过滤。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"name"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | 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 | **参数解释：** 总任务数量。 **取值范围：** 不涉及。 | 表3schedule_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 | **参数解释：** 数据库类型。 **取值范围：** - MySQL - PostgreSQL - SQLServer | | volume_type | String | **参数解释：** 磁盘类型。 **取值范围：** - ULTRAHIGH，表示超高IO型磁盘。 - LOCALSSD，表示本地SSD盘。 - CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。 - ESSD，表示极速型SSD。 | | target_config | object | **参数解释：** 目标配置。请参见[表4]。 | 表4target_config | 参数 | 参数类型 | 描述 | |:---|:---|:---| | flavor | String | **参数解释：** 实例规格。 当name参数值为RESIZE_FLAVOR时，表示目标规格。 **取值范围：** 不涉及。 | | cpu | String | **参数解释：** 实例CPU核数。 当name参数值为RESIZE_FLAVOR时，表示目标CPU。 **取值范围：** 不涉及。 | | mem | String | **参数解释：** 实例内存。单位：GB。 当name参数值为RESIZE_FLAVOR时，表示目标内存。 **取值范围：** 不涉及。 | - 正常响应样例 ``` { "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 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。