CreateCustomEndpoint - PolarDB - Alibaba Cloud Documentation Center

Operation description

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:CreateCustomEndpoint

create

*PolarDBXInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceName	string	Yes	The instance ID.	pxc-hzjasd****
Name	string	Yes	The name of the access control instance. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. The name can contain digits, underscores (_), and hyphens (-).	ext-win-live-17
VpcId	string	Yes	The ID of the virtual private cloud (VPC) in which the endpoint resides.	vpc-bp1ndoug37dtwoedlmru0
VSwitchId	string	Yes	The vSwitch ID.	vsw-*********
NodeIds	string	Yes	The IDs of the monitored nodes when RemindUnit (object type) is set to NODE (node). Separate multiple IDs with commas (,). A maximum of 50 nodes can be monitored by a single rule.	r-bp1l5kfgw8****c3iv
NodeAutoEnter	boolean	Yes	Specifies whether the node automatically joins the cluster and starts providing services after being added or recovered.	true
NodeRole	string	No	To query the metrics of a read-only node in a cloud-native read/write splitting architecture instance, specify READONLY for this parameter along with the specific NodeId. Note In other cases, you do not need to specify this parameter or you can specify MASTER.	READONLY
RegionId	string	No	The region in which the instance resides.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9
Data	object	The returned data.
CustomEndpointId	string	The endpoint ID.	pxe-c4gkgqg****7sgyg
DBInstanceName	string	The instance ID.	pxc-*********

Examples

Success response

JSON format

{
  "RequestId": "2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9",
  "Data": {
    "CustomEndpointId": "pxe-c4gkgqg****7sgyg",
    "DBInstanceName": "pxc-*********"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	CustomEndpoint.ExceedLimit	the count of custom endpoints can not exceed limiting value.	The number of custom connections exceeds the limit

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.