You can call this operation to query the network information of an AnalyticDB for MySQL cluster.
Debugging
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. |
Items | Array of Address |
The list of clusters. |
|
Address | |||
ConnectionString | String | am-bpxxxxxxxx.ads.aliyuncs.com |
The connection string of the cluster. |
IPAddress | String | 127.0.0.1 |
The IP address. |
NetType | String | VPC |
The network type of the endpoint. Valid values:
|
Port | String | 3306 |
The port for connections to the cluster. |
VPCId | String | vpc-xxxxxxxxx |
The ID of the VPC to which created clusters belong. |
VSwitchId | String | vsw-xxxxxx |
The ID of the vSwitch. |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeDBClusterNetInfo
&DBClusterId=am-bp1xxxxxxxx47
&<Common request parameters>
Sample success responses
XML
format
<ClusterNetworkType>VPC</ClusterNetworkType>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<Items>
<Address>
<VPCId>vpc-xxxxxxxxx</VPCId>
<Port>3306</Port>
<VSwitchId>vsw-xxxxxx</VSwitchId>
<ConnectionString>am-bpxxxxxxxx.ads.aliyuncs.com</ConnectionString>
<IPAddress>127.0.0.1</IPAddress>
<NetType>VPC</NetType>
</Address>
</Items>
JSON
format
{
"ClusterNetworkType": "VPC",
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"Items": {
"Address": {
"VPCId": "vpc-xxxxxxxxx",
"Port": 3306,
"VSwitchId": "vsw-xxxxxx",
"ConnectionString": "am-bpxxxxxxxx.ads.aliyuncs.com",
"IPAddress": "127.0.0.1",
"NetType": "VPC"
}
}
}
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 you specify the cluster ID value correctly. |
For a list of error codes, visit the API Error Center.