DescribeDBClusterNetInfo - - Alibaba Cloud Documentation Center

Queries information about database endpoints.

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

polardb:DescribeDBClusterNetInfo

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-****************
ConnectionStringType	string	No	The type of the endpoint. Valid values: Normal: the primary endpoint ReadWriteSplitting: the cluster endpoint MPP: the Massively Parallel Processing (MPP) endpoint	Normal

Response elements

Element	Type	Description	Example
	object	The information about the cluster endpoint.
DBClusterNetInfos	object
DBClusterNetInfo	array<object>	The information about the cluster endpoint.
	object	The information about the cluster endpoint.
VSwitchId	string	The ID of the vSwitch.	vsw-bp1li3eavsz8oaexq15dw
ConnectionStringType	string	The type of the endpoint. Valid values: Normal: the primary endpoint ReadWriteSplitting: the cluster endpoint MPP: the MPP endpoint	MPP
ConnectionString	string	The database endpoint.	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	The network type of the IP address. Valid values: Public: the Internet. Inner: the classic network. Private: a virtual private cloud (VPC).	Public
Port	string	The port number.	1521
VPCId	string	The ID of the VPC.	vpc-***************
IPAddress	string	The IP address.	121...173
ClusterNetworkType	string	The network type of the cluster. The value is fixed as VPC.	VPC
RequestId	string	The request ID.	72D99256-ACF1-5F86-831F-8CB53E9C23ED
DBNodeNetInfos	object
DBNodeNetInfo	array<object>	The information about the node endpoint.
	array<object>	The information about the node endpoint.
NetInfos	object
NetInfo	array<object>	The information about the node endpoint.
	object	The information about the node endpoint.
VSwitchId	string	The ID of the vSwitch.	vsw-*************
ConnectionString	string	The database endpoint.	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	The network type of the IP address. Valid values: Public: the Internet. Inner: the classic network. Private: a VPC.	Public
Port	string	The port number.	5432
VPCId	string	The ID of the VPC.	vpc-****************
IPAddress	string	The IP address.	47...203
DBNodeRole	string	The role of the node. Valid values: Writer: the primary node. Reader: a read-only node. ColumnReader: a column store read-only node. AI: an AI node.	Writer
DBInstanceId	string	The instance ID.	pc-*************

Examples

Success response

JSON format

{
  "DBClusterNetInfos": {
    "DBClusterNetInfo": [
      {
        "VSwitchId": "vsw-bp1li3eavsz8oaexq15dw",
        "ConnectionStringType": "MPP",
        "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com",
        "IPType": "Public",
        "Port": "1521",
        "VPCId": "vpc-***************",
        "IPAddress": "121.*.*.173"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "72D99256-ACF1-5F86-831F-8CB53E9C23ED",
  "DBNodeNetInfos": {
    "DBNodeNetInfo": [
      {
        "NetInfos": {
          "NetInfo": [
            {
              "VSwitchId": "vsw-*************",
              "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com\n",
              "IPType": "Public",
              "Port": "5432",
              "VPCId": "vpc-****************",
              "IPAddress": "47.*.*.203"
            }
          ]
        },
        "DBNodeRole": "Writer",
        "DBInstanceId": "pc-*************"
      }
    ]
  }
}

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 in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.