DescribeDBClusterEndpoints - PolarDB - Alibaba Cloud Documentation Center

Queries the endpoints of a PolarDB cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster. Note You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.	pc-*************
DBEndpointId	string	No	The ID of the endpoint.	pe-*************

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	2DC120BF-6EBA-4C63-BE99-B09F9E******
Items	array<object>	The information about the endpoints.
DBEndpoint	object
NodeWithRoles	string	The role name of each node in the endpoint. The role name of the primary node is Writer. Multiple read-only nodes can be associated with an endpoint. Therefore, the role name of each read-only node is suffixed with a number, such as Reader1 and Reader2. Note This parameter is valid only for PolarDB for PostgreSQL clusters and PolarDB for PostgreSQL (Compatible with Oracle)) clusters.	Reader1
Nodes	string	The nodes in the endpoint.	pi-*************,pi-*************
ReadWriteMode	string	The read/write mode. Valid values: ReadWrite: handles read and write requests. Automatic read/write splitting is enabled. ReadOnly: handles read-only requests.	ReadOnly
AddressItems	array<object>	The details of the endpoint.
Address	object	1
VSwitchId	string	The ID of the vSwitch.	vsw-************
PrivateZoneConnectionString	string	The private domain name that is bound to the endpoint.	*..*.com
ConnectionString	string	The endpoint.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
NetType	string	The network type of the endpoint. Valid values: Public Private	Private
Port	string	The port.	1521
VpcInstanceId	string	The ID of the virtual private cloud (VPC) instance. Note This parameter is returned for only PolarDB for MySQL clusters.	pe-*************
VPCId	string	The ID of the VPC.	vpc-***************
IPAddress	string	The IP address.	192.*..**
DBEndpointId	string	The ID of the endpoint.	pe-*************
EndpointConfig	string	The advanced configurations of the endpoint. DistributedTransaction: indicates whether transaction splitting is enabled. Valid values: on off ConsistLevel: the consistency level of sessions. Valid values: 0: eventual consistency. 1: session consistency. 2: global consistency. LoadBalanceStrategy: the load balancing policy that automatically schedules loads. Only load may be returned. MasterAcceptReads: indicates whether the primary node processes read requests. Valid values: on off	{\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}
DBEndpointDescription	string	The name of the endpoint.	test
EndpointType	string	The type of the endpoint. Valid values: Cluster: the default endpoint. Primary: the primary endpoint. Custom: a custom cluster endpoint.	Custom
AutoAddNewNodes	string	Indicates whether new nodes are automatically associated with the default cluster endpoint. Valid values: Enable Disable	Enable
DBClusterId	string	The ID of the cluster.	pc-bp1s826a1up******

Examples

Sample success responses

JSONformat

{
  "RequestId": "2DC120BF-6EBA-4C63-BE99-B09F9E******",
  "Items": [
    {
      "NodeWithRoles": "Reader1",
      "Nodes": "pi-***************,pi-***************",
      "ReadWriteMode": "ReadOnly",
      "AddressItems": [
        {
          "VSwitchId": "vsw-************",
          "PrivateZoneConnectionString": "***.***.**.com",
          "ConnectionString": "********.rwlb.polardb-pg-public.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "1521",
          "VpcInstanceId": "pe-*************",
          "VPCId": "vpc-***************",
          "IPAddress": "192.***.***.***"
        }
      ],
      "DBEndpointId": "pe-*************",
      "EndpointConfig": "{\\\"DistributedTransaction\\\":\\\"off\\\",\\\"ConsistLevel\\\":\\\"0\\\",\\\"LoadBalanceStrategy\\\":\\\"load\\\",\\\"MasterAcceptReads\\\":\\\"on\\\"}",
      "DBEndpointDescription": "test",
      "EndpointType": "Custom",
      "AutoAddNewNodes": "Enable",
      "DBClusterId": "pc-bp1s826a1up******",
      "SccMode": "",
      "PolarSccTimeoutAction": "",
      "PolarSccWaitTimeout": ""
    }
  ]
}

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.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-30	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-12	The Error code has changed	View Change Details
2023-07-20	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-05-11	The Error code has changed	View Change Details
2022-07-13	The Error code has changed	View Change Details