Updated on 2026-07-21 GMT+08:00

Querying the Status of Hot and Cold Data Separation

Function

This API is used to query the status of hot and cold data separation.

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

Dependencies

rds:coldTable:query

read

-

-

-

-

Constraints

This API is available only for RDS for PostgreSQL.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/hot-cold-separation/status

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    String

    Definition

    Instance ID.

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

None

Example Request

Query the status of hot and cold data separation.

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/hot-cold-separation/status

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    opened

    Boolean

    Definition

    Status of hot and cold data separation.

    Range

    • true: enabled
    • false: disabled

Status Code

Error Code

For details, see Error Codes.