Queries the network information about an ApsaraDB for ClickHouse cluster.

Request parameters

Parameter Type Required Example Description
Action String No DescribeDBClusterNetInfoItems

The operation that you want to perform. Set the value to DescribeDBClusterNetInfoItems.

DBClusterId String Yes cc-bp1qx68m06981****

The ID of the cluster.

Response parameters

Parameter Type Example Description
NetInfoItems Array of NetInfoItem

The network information about the cluster.

NetInfoItem
VpcId String vpc-bp175iuvg8nxqraf2****

The ID of the virtual private cloud (VPC).

Note If the value of the NetType parameter is set to Public, an empty string is returned.
VSwitchId String vsw-bp1gzt31twhlo0sa5****

The ID of the vSwitch.

Note If the value of the NetType parameter is set to Public, an empty string is returned.
ConnectionString String cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com

The endpoint of the cluster.

JdbcPort String 3306

The port number that is used in Java Database Connectivity (JDBC).

NetType String VPC

The network type of the endpoint. Valid values:

  • Public: the Internet
  • VPC: a VPC
HttpPort String 8123

The HTTP port number.

IPAddress String 10.255.234.251

The IP address of the cluster.

ClusterNetworkType String VPC

The network type of the cluster. Set the value to VPC.

RequestId String 9A23C87D-87DF-4DA0-A50E-CB13F4F7923D

The ID of the request.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=DescribeDBClusterNetInfoItems
&DBClusterId=cc-bp1qx68m06981****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterNetInfoItemsResponse>
    <NetInfoItems>
        <VpcId>vpc-bp175iuvg8nxqraf2****</VpcId>
        <VSwitchId>vsw-bp1gzt31twhlo0sa5****</VSwitchId>
        <ConnectionString>cc-bp1qx68m06981****.ads.rds.aliyuncs.com</ConnectionString>
        <JdbcPort>3306</JdbcPort>
        <NetType>VPC</NetType>
        <HttpPort>8123</HttpPort>
        <IPAddress>10.255.234.251</IPAddress>
    </NetInfoItems>
    <ClusterNetworkType>VPC</ClusterNetworkType>
    <RequestId>9A23C87D-87DF-4DA0-A50E-CB13F4F7923D</RequestId>
</DescribeDBClusterNetInfoItemsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NetInfoItems" : [ {
    "VpcId" : "vpc-bp175iuvg8nxqraf2****",
    "VSwitchId" : "vsw-bp1gzt31twhlo0sa5****",
    "ConnectionString" : "cc-bp1qx68m06981****.ads.rds.aliyuncs.com",
    "JdbcPort" : "3306",
    "NetType" : "VPC",
    "HttpPort" : "8123",
    "IPAddress" : "10.255.234.251"
  } ],
  "ClusterNetworkType" : "VPC",
  "RequestId" : "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D"
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Check whether the cluster ID is valid.

For a list of error codes, visit the API Error Center.