DescribeClusterNetInfo - AnalyticDB - Alibaba Cloud Documentation Center

Queries the network information about an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeClusterNetInfo	list	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	amv-wz9dqvn0o7****
Engine	string	No	The database engine of the cluster. Valid values: AnalyticDB (default): the AnalyticDB for MySQL engine. Clickhouse: the wide table engine.	Clickhouse

Response parameters

Parameter	Type	Description	Example
	object
ClusterNetworkType	string	The network type of the cluster. Only the Virtual Private Cloud (VPC) network type is supported. VPC is returned.	VPC
RequestId	string	The request ID.	69A29B65-CD0C-52B1-BE42-8B454569747F
Items	array<object>	The queried network information about the cluster.
Address	object	The network information about the cluster.
VSwitchId	string	The vSwitch ID of the cluster. Note If NetType is set to Public, an empty string is returned.	vsw-bp1syh8vvw8yec****
ConnectionString	string	The endpoint of the cluster. If NetType is set to VPC, the VPC endpoint of the cluster is returned. If NetType is set to Public, the public endpoint of the cluster is returned.	amv-wz9dqvn0o7****.ads.aliyuncs.com
NetType	string	The network type of the cluster. Valid values: Public: Internet. VPC: VPC.	VPC
Port	string	The port number that is used to connect to the cluster. 3306 is returned.	3306
VPCId	string	The VPC ID. Note If NetType is set to Public, an empty string is returned.	vpc-8vbhucmd5b****
IPAddress	string	The IP address of the endpoint. If NetType is set to VPC, the private IP address of the cluster is returned. If NetType is set to Public, the public IP address of the cluster is returned.	192.168.xx.xx
ConnectionStringPrefix	string	The prefix of the endpoint. If NetType is set to VPC, the prefix of the VPC endpoint is returned. If NetType is set to Public, the prefix of the public endpoint is returned.	amv-wz9dqvn0o7****
Ports	array<object>	The ports.
ports	object	The information about the port.
Port	string	The port.	3306
Protocol	string	The type of the protocol. Valid values: tcp http https mysql	mysql

Examples

Sample success responses

JSONformat

{
  "ClusterNetworkType": "VPC",
  "RequestId": "69A29B65-CD0C-52B1-BE42-8B454569747F",
  "Items": {
    "Address": [
      {
        "VSwitchId": "vsw-bp1syh8vvw8yec****",
        "ConnectionString": "amv-wz9dqvn0o7****.ads.aliyuncs.com",
        "NetType": "VPC",
        "Port": 3306,
        "VPCId": "vpc-8vbhucmd5b****",
        "IPAddress": "192.168.xx.xx",
        "ConnectionStringPrefix": "amv-wz9dqvn0o7****",
        "Ports": {
          "ports": [
            {
              "Port": 3306,
              "Protocol": "mysql"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ACS.InvalidParameter.%s	Parameter %s is invalid.	The specified parameter is invalid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Change history

Change time	Summary of changes	Operation
2024-06-13	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details