Queries the network information of 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBClusterNetInfo

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

DBClusterId String Yes am-bp1xxxxxxxx47

The ID of the cluster.

Response parameters

Parameter Type Example Description
ClusterNetworkType String VPC

The network type of the cluster.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Items Array of Address

The network information of the cluster.

Address
VSwitchId String vsw-xxxxxx

The ID of the vSwitch.

Note This parameter is empty when Public is returned for NetType.
ConnectionString String am-bpxxxxxxxx.ads.aliyuncs.com

The endpoint of the cluster.

NetType String VPC

The network type of the endpoint. Valid values:

  • Public: public endpoint
  • VPC: Virtual Private Cloud (VPC) endpoint
Port String 3306

The port number that is used to connect to the cluster.

VPCId String vpc-xxxxxxxxx

The ID of the VPC.

Note This parameter is empty when Public is returned for NetType.
IPAddress String 192.168.x.x

The IP address.

ConnectionStringPrefix String am-bpxxxxxxxx89k51380

The prefix of the cluster endpoint.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBClusterNetInfo
&DBClusterId=am-bp1xxxxxxxx47
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDBClusterNetInfoResponse>
    <ClusterNetworkType>VPC</ClusterNetworkType>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <Items>
        <VSwitchId>vsw-xxxxxx</VSwitchId>
        <ConnectionString>am-bpxxxxxxxx.ads.aliyuncs.com</ConnectionString>
        <NetType>VPC</NetType>
        <Port>3306</Port>
        <VPCId>vpc-xxxxxxxxx</VPCId>
        <IPAddress>192.168.x.x</IPAddress>
        <ConnectionStringPrefix>am-bpxxxxxxxx89k51380</ConnectionStringPrefix>
    </Items>
</DescribeDBClusterNetInfoResponse>

JSON format

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

{
  "ClusterNetworkType" : "VPC",
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items" : [ {
    "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 error message returned because the specified DBClusterId parameter does not exist. Check whether the cluster ID is valid.

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