Help Center/ TaurusDB/ API Reference/ APIs/ Cold and Hot Data Separation/ Querying Cold Table Metadata

Updated on 2026-08-31 GMT+08:00

View PDF

Querying Cold Table Metadata

Function

This API is used to query cold table metadata. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. To obtain this value, see Querying DB Instances. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0
limit	No	Integer	Definition Number of records returned by a query. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition Total number of cold table metadata records. Range ≥ 0
meta_info	ColdTableMetaInfo object	Definition List of cold table metadata records.
total_data_size	Float	Definition Total size of cold table data, in MB. Range ≥ 0

**Table 5** ColdTableMetaInfo
Parameter	Type	Description
space_id	String	Definition Tablespace ID. Range N/A
dd_id	String	Definition Table ID. Range N/A
database_name	String	Definition Database name of a cold table. Range N/A
table_name	String	Definition Name of a cold table. Range N/A
partition_name	String	Definition Name of a cold table partition. Range N/A
expiration_time	Long	Definition Validity period of a cold table, in seconds. Range ≥ 0
retained_time	Long	Definition Time that a cold table has been retained, in seconds. Range ≥ 0
data_size	Float	Definition Data volume of a cold table, in MB. Range ≥ 0

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying cold table metadata

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

Example Response

Status code: 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
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Cold and Hot Data Separation

Previous topic: Cold and Hot Data Separation

Next topic: Lock-Free Change