# 查询任务列表 - QueryingTasks #### 功能介绍 获取任务中心的任务列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 接口约束 最多查询最近一个月的任务列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListTasks)中调试该接口。 #### URI GET /v3/{project_id}/tasks 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | status | 否 | String | **参数解释：** 任务状态。 **约束限制：** 不涉及。 **取值范围：** - Running：运行中。 - Completed：完成。 - Failed：失败。 **默认取值** **：** 不涉及。 | | name | 否 | String | **参数解释：** 任务名称。 **约束限制：** 不涉及。 **取值范围：** - CreateGaussDBV5Instance：创建实例。 - BackupSnapshotGaussDBV5InInstance：手动创建备份。 - CloneGaussDBV5NewInstance：恢复到新实例。 - RestoreGaussDBV5InInstance：恢复到当前实例。 - RestoreGaussDBV5InInstanceToExistedInst：恢复到已有实例。 - DeleteGaussDBV5Instance：删除实例。 - EnlargeGaussDBV5Volume：磁盘扩容。 - ResizeGaussDBV5Flavor：规格变更。 - GaussDBV5ExpandClusterCN：协调节点扩容。 - GaussDBV5ExpandClusterDN：分片扩容。 **默认取值** **：** 不涉及。 | | start_time | 否 | String | **参数解释：** 开始时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | end_time | 否 | String | **参数解释：** 结束时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。 **约束限制：** 不涉及。 **取值范围：** 0 \~ 2,147,483,647。 **默认取值** **：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值** **：** 默认为100。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | tasks | Array of objects | **参数解释：** 任务列表。 详情请参见[表3 tasks字段数据结构说明]。 | | total_count | Integer | **参数解释：** 任务数量。 **取值范围：** 不涉及。 | 表4tasks字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | instance_info | Object | **参数解释：** 任务绑定的实例信息。 详情请参见[表4 instance_info字段数据结构说明]。 | | job_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 任务名称。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 任务状态。 **取值范围：** - Running：运行中。 - Completed：完成。 - Failed：失败。 | | process | String | **参数解释：** 任务进度，单位：%。 **取值范围：** 不涉及。 | | created_at | String | **参数解释：** 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | ended_at | String | **参数解释：** 结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | fail_reason | String | **参数解释：** 失败原因。 **取值范围：** 不涉及。 | 表5instance_info字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | instance_status | String | **参数解释：** 实例状态。 **取值范围：** - 值为"BUILD"，表示实例正在创建。 - 值为"BUILD_FAILED"，表示实例创建失败。 - 值为"ACTIVE"，表示实例正常。 - 值为"FAILED"，表示实例异常。 - 值为"FROZEN"，表示实例冻结。 - 值为"MODIFYING"，表示实例正在扩容磁盘或者变更规格。 - 值为"EXPANDING"，表示实例正在添加只读节点或扩容CN或DN。 - 值为"REBOOTING"，表示实例正在重启。 - 值为"REDUCING", 表示实例正在删除只读节点。 - 值为"UPGRADING"，表示实例正在升级。 - 值为"RESTORING"，表示实例正在恢复。 - 值为"SWITCHOVER"，表示实例正在主备切换。 - 值为"MIGRATING"，表示实例正在迁移。 - 值为"BACKING UP"，表示实例正在进行备份。 - 值为"UPGRADE TO BE OBSERVED"，表示实例正在进行升级待观察。 - 值为"MODIFYING DATABASE PORT"，表示实例正在修改数据库端口。 - 值为"STORAGE FULL"，表示实例磁盘空间满。 - 值为"REPAIRING"，表示实例正在修复。 - 值为"SHUTDOWN"，表示实例已停止。 | #### 请求示例 - 查询任务状态为"运行中"的任务列表 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&name=CreateGaussDBV5Instance&offset=1&limit=10 ``` - 查询任务状态为"完成"的任务列表 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Completed&name=CreateGaussDBV5Instance&offset=1&limit=10 ``` - 查询任务状态为"失败"的任务列表 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Failed&name=CreateGaussDBV5Instance&offset=1&limit=10 ``` #### 响应示例 查询任务列表成功。 ``` { "tasks" : [ { "instance_info" : { "instance_id" : "ce2dce50f365430abe161bab79495a6ein14", "instance_name" : "gauss-6568-zzh", "instance_status" : "BUILD" }, "job_id" : "03bc055a-135c-4245-8bd8-b0bc6d3350b3", "name" : "CreateGaussDBV5Instance", "status" : "Failed", "process" : "", "created_at": "2022-08-05T08:15:07+0800", "ended_at": "2022-08-09T03:06:52+0800", "fail_reason" : "500000" }, { "instance_info" : { "instance_id" : "20ba433bd7ee40da9cf35064f04f9e4cin14", "instance_name" : "gauss-7875-lt-m", "instance_status" : "MODIFYING" }, "job_id" : "2cc16e0b-75ab-4a28-9453-16517e990bba", "name" : "DeleteGaussDBV5Instance", "status" : "Completed", "process" : "", "created_at": "2022-08-06T09:15:07+0800", "ended_at": "2022-08-10T03:06:52+0800", "fail_reason" : null } ], "total_count" : 2 } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。