Call DescribeDBClusterNetInfo to retrieve cluster network information - AnalyticDB

Call the DescribeDBClusterNetInfo API to retrieve network information about an ADB cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeDBClusterNetInfo

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
ClusterNetworkType	string	Cluster network type.	VPC
RequestId	string	Request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	object
Address	array<object>	List of clusters.
	object
VSwitchId	string	vSwitch ID. Note If NetType is Public, the vSwitch ID is empty.	vsw-xxxxxx
ConnectionString	string	Cluster connection address.	am-bpxxxxxxxx.ads.aliyuncs.com
NetType	string	Network type. Valid values: Public: Public network. VPC: VPC.	VPC
Port	string	Cluster connection port.	3306
VPCId	string	VPC ID. Note If NetType is Public, the VPC ID is empty.	vpc-xxxxxxxxx
IPAddress	string	IP address.	192.168.x.x
ConnectionStringPrefix	string	Cluster connection address prefix.	am-bpxxxxxxxx89k51380

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.