All Products
Search
Document Center

DescribeDBClusterNetInfo

Last Updated: Aug 04, 2020

Queries network information about an AnalyticDB for MySQL cluster.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeDBClusterNetInfoThe operation that you want to perform. Set the value to DescribeDBClusterNetInfo.

DBClusterIdsStringYesam-bp1xxxxxxxx47The ID of the cluster whose network information is to be queried.

Response parameters

ParameterTypeExampleDescription
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEFThe ID of the request.
ItemsList<Address>-The network information about the cluster.

Address

ParameterTypeExampleDescription
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:
  • Public: Internet
  • VPC: Virtual Private Cloud (VPC)
VPCId String vpc-xxxxxxxxx The VPC ID of the cluster.
VSwitchId String vsw-xxxxxx The VSwitch ID of the cluster.

Examples

Sample requests

  1. http(s)://[Endpoint]/?Action=DescribeDBClusterNetInfo
  2. &DBClusterId=am-xxxxxxxxxx
  3. &<Common request parameters>

Sample success responses

XML format

  1. <DescribeDBClusterNetInfoResponse>
  2. <Items>
  3. <Address>
  4. <Port>3306</Port>
  5. <ConnectionString>am-bpxxxxxxx.ads.aliyuncs.com</ConnectionString>
  6. <VPCId>vpc-bpxxxxxxx6zo</VPCId>
  7. <IPAddress>127.0.0.1</IPAddress>
  8. <NetType>VPC</NetType>
  9. <VSwitchId>vsw-bpxxxxxxx</VSwitchId>
  10. </Address>
  11. </Items>
  12. <ClusterNetworkType>VPC</ClusterNetworkType>
  13. <RequestId>9A23C87D-87DF-4DA0-A50E-CB13F4F7923D</RequestId>
  14. </DescribeDBClusterNetInfoResponse>

JSON format

  1. {
  2. "Items": {
  3. "Address": [
  4. {
  5. "Port": "3306",
  6. "ConnectionString": "am-bpxxxxxx.ads.aliyuncs.com",
  7. "VPCId": "vpc-bpxxxxxxx",
  8. "IPAddress": "127.0.0.1",
  9. "NetType": "VPC",
  10. "VSwitchId": "vsw-bpxxxxxxx"
  11. }
  12. ]
  13. },
  14. "ClusterNetworkType": "VPC",
  15. "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D"
  16. }