DescribeDBClusterNodeInfos - 获取实例节点信息

获取ClickHouse社区兼容版实例节点信息

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

DBClusterId

string

集群 ID。

cc-bp108z124a8o7****

PageSize

integer

每页记录数,取值:

  • 30(默认值)

  • 50

  • 100

30

PageNumber

integer

页数。

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

746CD303-0B82-5E8D-886D-93A9FAF3A876

NodeInfos

array<object>

ClickHouse 节点信息。

object

节点信息。

ShardId

string

分片 ID。

2

ReplicaId

string

节点 ID。

1

NodeName

string

节点名称。

ck-bp108z124a8****

NodeIp

string

节点 IP。

172.168.0.1

FailoverTesting

boolean

是否正在进行容灾测试。

true

ZkNodeInfos

array<object>

Zookeeper 节点信息。

object

ReplicaId

string

Zookeeper 节点 ID。

1

NodeName

string

节点名称。

ck-bp108z124a8****

FailoverTesting

boolean

是否正在进行容灾测试。

true

PageNumber

integer

页数。

1

PageSize

integer

每页记录数,取值:

  • 30(默认值)

  • 50

  • 100

30

TotalNodeCount

integer

节点总数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "746CD303-0B82-5E8D-886D-93A9FAF3A876",
  "NodeInfos": [
    {
      "ShardId": "2",
      "ReplicaId": "1",
      "NodeName": "ck-bp108z124a8****",
      "NodeIp": "172.168.0.1",
      "FailoverTesting": true
    }
  ],
  "ZkNodeInfos": [
    {
      "ReplicaId": "1",
      "NodeName": "ck-bp108z124a8****\n",
      "FailoverTesting": true
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "TotalNodeCount": 1
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError An error occurred while processing your request. 系统内部错误,请稍后重试
503 ServiceUnavailable An error occurred while processing your request. 系统暂时不可用,请稍后重试

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情