DescribeDBClusterNodeInfos - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries node information for a ClickHouse Community-Compatible instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID.	cc-bp108z124a8o7****
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	746CD303-0B82-5E8D-886D-93A9FAF3A876
NodeInfos	array<object>	The information about the ClickHouse nodes.
	object	The node information.
ShardId	string	The shard ID.	2
ReplicaId	string	The node ID.	1
NodeName	string	The node name.	ck-bp108z124a8****
NodeIp	string	The IP address of the node.	172.168.0.1
FailoverTesting	boolean	Indicates whether a disaster recovery test is in progress.	true
ZkNodeInfos	array<object>	The information about the ZooKeeper nodes.
	object
ReplicaId	string	The ZooKeeper node ID.	1
NodeName	string	The node name.	ck-bp108z124a8****
FailoverTesting	boolean	Indicates whether a disaster recovery test is in progress.	true
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Valid values: 30 (default) 50 100	30
TotalNodeCount	integer	The total number of nodes.	1

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.