文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 查询协调节点列表
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

查询协调节点列表

功能介绍

查询协调节点列表。

调试

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

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/coordinators

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

实例ID，严格匹配UUID规则。

offset

否

Integer

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

limit

否

Integer

查询记录数。默认为200，不能为负数，最小值为1，最大值为200。

请求参数

无。

响应参数

表2 响应Body参数

参数

参数类型

描述

instance_id

String

实例ID。

max_reduction_num

Integer

单次缩容允许最大步长。

nodes

Array of 表3 objects

节点信息列表。
表3 CnInfoBeforeReduce

参数

参数类型

描述

id

String

节点ID。

name

String

节点名称。

status

String

节点状态。

  • 值为“normal”，表示节点正常。
  • 值为“abnormal”，表示节点异常。
  • 值为“creating”，表示节点正在创建。
  • 值为“createfail”，表示节点创建失败。

availability_zone

String

可用区。

support_reduce

Boolean

是否允许删除。

请求示例

查询协调节点列表。

GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/coordinators

响应示例

查询协调节点列表成功。

{ 
  "instance_id" : "cc6fd964d93f4003851dfc29d57d30a5in14", 
  "max_reduction_num" : 10, 
  "nodes" : [ { 
    "id" : "25b7f16ee4084b7884d52f1bdfab4e68no14", 
    "name" : "UTS-gauss-7362_gaussdbv5cn_0", 
    "status" : "normal", 
    "availability_zone" : "az2", 
    "support_reduce" : true 
  }, { 
    "id" : "ad6f02f31744422fa8ce487e81c9e7afno14", 
    "name" : "UTS-gauss-7362_gaussdbv5cn_1", 
    "status" : "normal", 
    "availability_zone" : "az3", 
    "support_reduce" : true 
  } ] 
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档