文档首页/ 云数据库 TaurusDB/ API参考/ API/ 冷热分离/ 查询冷热分离可归档表信息 - ListArchivableTables
更新时间:2026-11-10 GMT+08:00
分享

查询冷热分离可归档表信息 - ListArchivableTables

功能介绍

查询指定实例下可归档的表信息,包括数据库名、表名及分区名。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:coldTable:query

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:coldTable:query

    -

URI

GET /v3/{project_id}/instances/{instance_id}/cold-tables/archivable-tables

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID,此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

db_name

是

String

参数解释:

数据库名。

获取方法请参见查询数据库列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

table_name

否

String

参数解释:

表名。

约束限制:

参数值必须为指定数据库中已存在的表。

取值范围:

不涉及。

默认取值:

不涉及。

partition_name

否

String

参数解释:

分区名。

约束限制:

依赖table_name,参数值必须为指定数据库和指定表中已存在的分区。

取值范围:

不涉及。

默认取值:

不涉及。

offset

否

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制:

必须为整数,不能为负数。

取值范围:

≥0。

默认取值:

0。

limit

否

Integer

参数解释:

查询记录数。

约束限制:

必须为整数,不能为负数。

取值范围:

1-50。

默认取值:

50。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

否

String

参数解释:

请求语言类型。

约束限制:

不涉及。

取值范围:

  • en-us:英文。

  • zh-cn:中文。

默认取值:

en-us。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

总记录数。

取值范围:

大于等于0。

archivable_tables

Array of ArchivableTable objects

参数解释:

可归档表信息。

表5 ArchivableTable

参数

参数类型

描述

db_name

String

参数解释:

数据库名。

取值范围:

不涉及。

table_name

String

参数解释:

表名。

取值范围:

不涉及。

partition_name

String

参数解释:

分区名,为空表示无分区表。

取值范围:

不涉及。

restricted

Boolean

参数解释:

是否存在限制或约束。

取值范围:

  • true:存在限制或约束,归档受限。

  • false:无限制或约束,可归档。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例下db1库中orders表的可归档表信息。

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/cold-tables/archivable-tables?db_name=db1&table_name=orders&offset=0&limit=50

响应示例

状态码:200

{
  "total_count" : 2,
  "archivable_tables" : [ {
    "db_name" : "db1",
    "table_name" : "orders",
    "partition_name" : "p202301",
    "restricted" : false
  }, {
    "db_name" : "db1",
    "table_name" : "logs",
    "partition_name" : "",
    "restricted" : true
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

相关文档