# 查询即时任务列表 - ListTasks #### 功能介绍 查询即时任务列表。 - 调用接口前，您需要了解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=ListTasks)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:task:listAll | - | - | - | rds:task:list | - | #### 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](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0。偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 50\] **默认取值：** 10 | | id | 否 | String | **参数解释：** 任务ID，按照任务ID过滤。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | 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"获取。 **默认取值：** 不涉及。 | | 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]。 | 表3tasks字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 } ``` - 异常响应 请参见[异常响应结果](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)。