All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeDBClusterNetInfoItems

Last Updated:Nov 12, 2024

Queries the network information about an ApsaraDB for ClickHouse cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeDBClusterNetInfoItemsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-bp1qx68m06981****

Response parameters

ParameterTypeDescriptionExample
object
NetInfoItemsarray<object>

The network information about the cluster.

NetInfoItemobject
VpcIdstring

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****
VSwitchIdstring

The vSwitch ID.

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

The endpoint that is used to connect to the database.

cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com
JdbcPortstring

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

3306
NetTypestring

The network type of the endpoint. Valid values:

  • Public: public endpoint
  • VPC: VPC
VPC
HttpPortstring

The HTTP port number.

8123
IPAddressstring

The IP address.

10.255.234.251
HttpsPortstring

The HTTPS port number.

8443
MySQLPortstring

The port of the MySQL instance.

9004
ClusterNetworkTypestring

The network type of the cluster. Only VPC is supported.

VPC
RequestIdstring

The request ID.

9A23C87D-87DF-4DA0-A50E-CB13F4F7923D
EnableSLBboolean

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 codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
2022-12-16API Description Update. The Error code has changed. The response structure of the API has changedView Change Details