# 查询冷热分离已下发任务列表 - ListColdTableTasks #### 功能介绍 查询指定实例已下发的任务列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:coldTable:query | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:coldTable:query | - | #### URI GET /v3/{project_id}/instances/{instance_id}/cold-tables/tasks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 获取方法请参见[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制**： 必须为整数，不能为负数。 **取值范围**： ≥0。 **默认取值**： 0。 | | limit | 否 | Integer | **参数解释**： 查询记录数。 **约束限制**： 必须为整数，不能为负数。 **取值范围**： 1-100。 **默认取值**： 100。 | #### 请求参数 表3请求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 | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释**： 总记录数。 **取值范围**： 大于等于0。 | | tasks | Array of [ColdTableTask] objects | **参数解释**： 已下发任务列表。 | 表5ColdTableTask | 参数 | 参数类型 | 描述 | |:---|:---|:---| | db_name | String | **参数解释**： 数据库名。 **取值范围**： 不涉及。 | | table_name | String | **参数解释**： 表名。 **取值范围**： 不涉及。 | | partition_name | String | **参数解释**： 分区名，为空表示无分区表。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 任务状态。 **取值范围**： - BEGIN：开始。 - RUNNING：进行中。 - FINISH：已完成。 - FAIL：失败。 - REVOKE：回滚。 | | target_storage | String | **参数解释**： 操作类型。 **取值范围**： - OBS：创建冷表。 - SLICE：回迁冷表。 | | percent | Double | **参数解释**： 任务进度百分比。 **取值范围**： 0-1。 | | total_cnt | Double | **参数解释**： 对象数。 **取值范围**： 非负数。 | | space_id | String | **参数解释**： 表空间ID。 **取值范围**： 不涉及。 | | version | String | **参数解释**： 冷表版本。 **取值范围**： 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 查询实例下冷热分离已下发任务列表。 ``` GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/cold-tables/tasks?offset=0&limit=100 ``` #### 响应示例 **状态码：200** ``` { "total_count" : 2, "tasks" : [ { "db_name" : "db1", "table_name" : "orders", "partition_name" : "p202301", "status" : "FINISH", "target_storage" : "OBS", "percent" : 1.0, "total_cnt" : 100.0, "space_id" : "123", "version" : "1.0" }, { "db_name" : "db1", "table_name" : "logs", "partition_name" : "", "status" : "RUNNING", "target_storage" : "OBS", "percent" : 0.5, "total_cnt" : 200.0, "space_id" : "456", "version" : "1.0" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。