DescribeDBClusterNetInfo - AnalyticDB - Alibaba Cloud Documentation Center

Queries the network information about an AnalyticDB for MySQL 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

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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeDBClusterNetInfo	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	am-bp1xxxxxxxx47
RegionId	string	No	The region ID of the cluster.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
ClusterNetworkType	string	The network type of the cluster.	VPC
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	array<object>	The queried network information about the cluster.
	object
VSwitchId	string	The vSwitch ID. Note If NetType is set to Public, an empty string is returned for this parameter.	vsw-xxxxxx
ConnectionString	string	The endpoint of the cluster.	am-bpxxxxxxxx.ads.aliyuncs.com
NetType	string	The network type of the cluster. Valid values: Public: public endpoint. VPC: Virtual Private Cloud (VPC) endpoint.	VPC
Port	string	The port number that is used to connect to the cluster.	3306
VPCId	string	The VPC ID. Note If NetType is set to Public, an empty string is returned for this parameter.	vpc-xxxxxxxxx
IPAddress	string	The IP address.	192.168.x.x
ConnectionStringPrefix	string	The prefix of the cluster endpoint.	am-bpxxxxxxxx89k51380

Examples

Sample success responses

JSONformat

{
  "ClusterNetworkType": "VPC",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "Address": [
      {
        "VSwitchId": "vsw-xxxxxx",
        "ConnectionString": "am-bpxxxxxxxx.ads.aliyuncs.com",
        "NetType": "VPC",
        "Port": "3306",
        "VPCId": "vpc-xxxxxxxxx",
        "IPAddress": "192.168.x.x",
        "ConnectionStringPrefix": "am-bpxxxxxxxx89k51380"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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-05-17	The Error code has changed. The request parameters of the API has changed	View Change Details