DescribeDBClusterNetInfoItems - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the network information about an ApsaraDB for ClickHouse cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp1qx68m06981****

Response parameters

Parameter	Type	Description	Example
	object
NetInfoItems	array<object>	The network information about the cluster.
	object
VpcId	string	The virtual private cloud (VPC) ID. Note If the value of the NetType parameter is set to Public, an empty string is returned.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	The vSwitch ID. Note If the value of the NetType parameter is set to Public, an empty string is returned.	vsw-bp1gzt31twhlo0sa5****
ConnectionString	string	The endpoint that is used to connect to the database.	cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com
JdbcPort	string	The port number that is used in Java Database Connectivity (JDBC).	3306
NetType	string	The network type of the endpoint. Valid values: Public: public endpoint VPC: VPC	VPC
HttpPort	string	The HTTP port number.	8123
IPAddress	string	The IP address.	10.255.234.251
HttpsPort	string	The HTTPS port number.	8443
MySQLPort	string	The port of the MySQL instance.	9004
ClusterNetworkType	string	The network type of the cluster. Only VPC is supported.	VPC
RequestId	string	The request ID.	9A23C87D-87DF-4DA0-A50E-CB13F4F7923D
EnableSLB	boolean	Indicates whether Server Load Balancer (SLB) is activated in the VPC. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "NetInfoItems": {
    "NetInfoItem": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "ConnectionString": "cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com",
        "JdbcPort": "3306",
        "NetType": "VPC",
        "HttpPort": "8123",
        "IPAddress": "10.255.234.251",
        "HttpsPort": "8443",
        "MySQLPort": "9004"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D",
  "EnableSLB": true
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-12-16	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details