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

查询冷表元信息 - ListColdTableMetas

功能介绍

查询冷表元信息。

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:coldTable:query

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:coldTable:query

    -

URI

GET /v3.1/{project_id}/instances/{instance_id}/cold-tables/meta

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

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

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

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

约束限制

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

取值范围

≥0

默认取值

0

limit

Integer

参数解释

查询记录数。

约束限制

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

取值范围

1-100。

默认取值

10。

请求参数

表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

Integer

参数解释

冷表元信息记录总数。

取值范围

≥0。

meta_info

ColdTableMetaInfo object

参数解释

冷表元记录列表。

total_data_size

Float

参数解释

冷表数据量总大小(MB)。

取值范围

≥0。

表5 ColdTableMetaInfo

参数

参数类型

描述

space_id

String

参数解释

表空间ID。

取值范围

不涉及。

dd_id

String

参数解释

表ID。

取值范围

不涉及。

database_name

String

参数解释

冷表库名。

取值范围

不涉及。

table_name

String

参数解释

冷表表名。

取值范围

不涉及。

partition_name

String

参数解释

冷表分区名。

取值范围

不涉及。

expiration_time

Long

参数解释

冷表有效周期(秒)。

取值范围

≥0。

retained_time

Long

参数解释

冷表已保留时间(秒)。

取值范围

≥0。

data_size

Float

参数解释

冷表数据量大小(MB)。

取值范围

≥0。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询冷表元信息。

GET https://{endpoint}/v3.1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/cold-tables/meta?offset=0&limit=10

响应示例

状态码:200

Success.

{
  "meta_info" : [ {
    "space_id" : "20",
    "dd_id" : "100",
    "database_name" : "test_db",
    "table_name" : "test_table",
    "partition_name" : "p1",
    "expiration_time" : 691200,
    "retained_time" : 0,
    "data_size" : 1
  } ],
  "total" : 1,
  "total_data_size" : 1
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档