Queries network information about an AnalyticDB for MySQL cluster.
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | DescribeDBClusterNetInfo | The operation that you want to perform. Set the value to DescribeDBClusterNetInfo. |
| DBClusterIds | String | Yes | am-bp1xxxxxxxx47 | The ID of the cluster whose network information is to be queried. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | The ID of the request. |
| Items | List<Address> | - | The network information about the cluster. |
Address
| Parameter | Type | Example | Description |
|---|---|---|---|
| ConnectionString | String | am-bpxxxxxxxx.ads.aliyuncs.com | The connection string of the cluster. |
| IPAddress | String | 127.0.0.1 | The IP address of the cluster. |
| Port | String | 3306 | The port number of the cluster. |
| NetType | String | Public | The network type of the cluster. Valid values:
|
| VPCId | String | vpc-xxxxxxxxx | The VPC ID of the cluster. |
| VSwitchId | String | vsw-xxxxxx | The VSwitch ID of the cluster. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeDBClusterNetInfo&DBClusterId=am-xxxxxxxxxx&<Common request parameters>
Sample success responses
XML format
<DescribeDBClusterNetInfoResponse><Items><Address><Port>3306</Port><ConnectionString>am-bpxxxxxxx.ads.aliyuncs.com</ConnectionString><VPCId>vpc-bpxxxxxxx6zo</VPCId><IPAddress>127.0.0.1</IPAddress><NetType>VPC</NetType><VSwitchId>vsw-bpxxxxxxx</VSwitchId></Address></Items><ClusterNetworkType>VPC</ClusterNetworkType><RequestId>9A23C87D-87DF-4DA0-A50E-CB13F4F7923D</RequestId></DescribeDBClusterNetInfoResponse>
JSON format
{"Items": {"Address": [{"Port": "3306","ConnectionString": "am-bpxxxxxx.ads.aliyuncs.com","VPCId": "vpc-bpxxxxxxx","IPAddress": "127.0.0.1","NetType": "VPC","VSwitchId": "vsw-bpxxxxxxx"}]},"ClusterNetworkType": "VPC","RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D"}