文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 冷热分离（PostgreSQL）/ 查询冷热分离功能开启状态 - ShowHotClodSeparationStatus
更新时间：2026-07-01 GMT+08:00
查看PDF
分享

查询冷热分离功能开启状态 - ShowHotClodSeparationStatus

功能介绍

查询冷热分离功能开启状态。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:coldTable:query

read

-

-

-

-

接口约束

该接口目前仅支持RDS for PostgreSQL引擎。

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    可调用查询数据库实例列表接口，通过表4中的“id”获取。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

无。

请求示例

查询冷热分离功能开启状态。

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

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    opened

    Boolean

    参数解释：

    冷热分离功能开启状态。

    取值范围：

    • true：开启。
    • false：关闭。
  • 正常响应样例 
    {
"opened": true
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

相关文档