DescribeCustomEndpointList - PolarDB - Alibaba Cloud Documentation Center

Queries the list of user-defined custom domain names.

Operation description

This operation retrieves the list of custom endpoints configured by the user, which facilitates the management and viewing of private connection or VPC endpoint service settings.

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

polardbx:DescribeCustomEndpointList

list

*PolarDBXInstance

acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region where the instance resides.	cn-hangzhou
DBInstanceName	string	Yes	The name of the instance.	pxc-xxx
CustomEndpointIds	string	No	The custom endpoint IDs.	pxe-b6e****no4pfap1s
CheckDeleteCN	boolean	No	Specifies whether to check if the CN node has been deleted.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	6352AC16-76BF-5135-B1EA-ED49293526E6
Data	object	The data struct.
CanDeleteCount	integer	Indicates whether the node can be deleted.	0
Endpoints	array<object>	The endpoint details.
	object	The endpoint details.
CustomEndpointId	string	The ID of the custom endpoint.	pxe-b6e****o4pfap1s
Name	string	The name of the custom endpoint.	Name
DBInstanceName	string	The instance ID.	pxc-hz****zoxherr7
ConnectionString	string	The endpoint of the instance.	pxc-shra****zq0j01.polarx.rds.aliyuncs.com
Port	integer	The port used to connect to the instance.	3306
VpcId	string	The ID of the virtual private cloud (VPC) in which the endpoint resides.	vpc-uf61h****dj1zg5fqp5x7
VSwitchId	string	The ID of the vSwitch.	vsw-8vbkw****5yh4nrd639ih
NodeAutoEnter	string	Indicates whether a node automatically joins the cluster and starts providing services after the node is added or recovered.	true
NodeRole	string	To query the metrics of a read-only node in a cloud-native read/write splitting architecture instance, set this parameter to READONLY and specify the NodeId parameter. Note In other cases, you do not need to specify this parameter or you can set it to MASTER.	same_azone_as_last
CnNames	array	["pxc-i-vb1sqa7llp","pxc-i-bemprx50ad"]
	string	string	string
Status	string	The status of the custom endpoint.	created

Examples

Success response

JSON format

{
  "RequestId": "6352AC16-76BF-5135-B1EA-ED49293526E6",
  "Data": {
    "CanDeleteCount": 0,
    "Endpoints": [
      {
        "CustomEndpointId": "pxe-b6e****o4pfap1s",
        "Name": "Name",
        "DBInstanceName": "pxc-hz****zoxherr7",
        "ConnectionString": "pxc-shra****zq0j01.polarx.rds.aliyuncs.com",
        "Port": 3306,
        "VpcId": "vpc-uf61h****dj1zg5fqp5x7",
        "VSwitchId": "vsw-8vbkw****5yh4nrd639ih",
        "NodeAutoEnter": "true",
        "NodeRole": "same_azone_as_last",
        "CnNames": [
          "string"
        ],
        "Status": "created"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.