文档首页/云数据库 GaussDB/API参考/API（推荐）/实例管理/查询只读节点信息 - QueryingReadReplicaInformation
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

查询只读节点信息 - QueryingReadReplicaInformation

功能介绍

查询实例的只读节点列表，以及实例可支持的最大只读节点数。

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/readonly-nodes

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表3 响应参数

参数

参数类型

描述

nodes

Array of 表4objects

参数解释：

只读节点列表。

max_readonly_node_num

Integer

参数解释：

实例可添加的最大只读节点数。

取值范围：

不涉及。

表4 ListReadonlyNodesResult字段数据结构说明

参数

参数类型

描述

id

String

参数解释：

节点ID。

取值范围：

不涉及。

name

String

参数解释：

节点名称。

取值范围：

不涉及。

status

String

参数解释：

节点状态。

取值范围：

  • normal：节点正常。
  • abnormal：节点异常。
  • creating：节点正在创建。
  • createfail：节点创建失败。

availability_zone

String

参数解释：

节点所在的可用区。

取值范围：

不涉及。

请求示例

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/95e33e5453684df9a300973f28751b5din14/readonly-nodes

响应示例

{ 
  "nodes" : [ { 
    "id" : "b36d146eb751424dbeecacdcb3287732no14", 
    "name" : "hwc-test -0000_root_3", 
    "status" : "normal", 
    "availability_zone" : " az2xahz" 
  } ], 
  "max_readonly_node_num" : 3 
}

状态码

错误码

请参见错误码。

父主题：实例管理