Create Custom Cluster Endpoints to Isolate Workloads - PolarDB - Alibaba Cloud - PolarDB

Creates a custom cluster endpoint for a PolarDB 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-**************
EndpointType	string	Yes	The type of the custom cluster endpoint. Valid values: Custom: custom cluster endpoint. DynamoDB: DynamoDB endpoint.	Custom
Nodes	string	No	The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). By default, all nodes are added. Note For PolarDB for MySQL, specify node IDs. For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), specify node role names, such as `Writer,Reader1,Reader2`. If ReadWriteMode is set to ReadOnly, you can mount only one node. However, if this node fails, the endpoint may be unavailable for up to 1 hour. Do not use this configuration in production environments. Select at least 2 nodes to improve availability. If ReadWriteMode is set to ReadWrite, select at least 2 nodes. * For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node. * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), the primary node must be included.	pi-********,pi-*******
ReadWriteMode	string	No	The read/write mode. Valid values: ReadWrite: read/write (automatic read/write splitting). ReadOnly (default): read-only.	ReadOnly
AutoAddNewNodes	string	No	Specifies whether new nodes are automatically added to this endpoint. Valid values: Enable: New nodes are automatically added to this endpoint. Disable (default): New nodes are not automatically added to this endpoint.	Disable
EndpointConfig	string	No	The advanced configurations of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, offload reads from primary node, and connection pool settings. Load balancing policy. Format: {"LoadBalancePolicy":"Load balancing policy"}. Valid values: 0: connection-based load balancing (default). 1: active-request-based load balancing. Consistency level. Format: `{"ConsistLevel":"Consistency level"}`. Valid values: 0: eventual consistency. 1: session consistency (default). 2: global consistency. Transaction splitting. Format: `{"DistributedTransaction":"Transaction splitting"}`. Valid values: on: enables transaction splitting (default). off: disables transaction splitting. Offload reads from primary node. Format: `{"MasterAcceptReads":"Offload reads from primary node"}`. Valid values: on: the primary node accepts read requests. off: the primary node does not accept read requests (default). Connection pool. Format: `{"ConnectionPersist":"Connection pool"}`. Valid values: off: disables the connection pool (default). Session: enables session-level connection pooling. Transaction: enables transaction-level connection pooling. Parallel query. Format: {"MaxParallelDegree":"Parallel query"}. Valid values: A specific degree of parallelism. Example: "MaxParallelDegree":"2". off: disables parallel query (default). Automatic request distribution among row store and column store nodes. Format: {"EnableHtapImci":"Automatic request distribution among row store and column store nodes"}. Valid values: on: enables automatic request distribution among row store and column store nodes. off: disables automatic request distribution among row store and column store nodes (default). Overload protection. Format: {"EnableOverloadThrottle":"Overload protection"}. Valid values: on: enables overload protection. off: disables overload protection (default). Note Transaction splitting, offload reads from primary node, connection pool, and overload protection can be configured only when the read/write mode of the PolarDB for MySQL cluster endpoint is ReadWrite (automatic read/write splitting). When the read/write mode of the PolarDB for MySQL cluster endpoint is ReadOnly, both connection-based load balancing and active-request-based load balancing are supported. The ReadWrite (automatic read/write splitting) mode supports only active-request-based load balancing. Automatic request distribution among row store and column store nodes can be configured when the read/write mode of the PolarDB for MySQL cluster endpoint is ReadWrite (automatic read/write splitting), or when the read/write mode is ReadOnly and the load balancing policy is active-request-based load balancing. Only PolarDB for MySQL supports setting the consistency level to global consistency. If ReadWriteMode is set to ReadOnly, the consistency level can only be set to 0. You can configure the consistency level, transaction splitting, offload reads from primary node, and connection pool at the same time. Example: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`. Transaction splitting is constrained by the consistency level. For example, transaction splitting cannot be enabled when the consistency level is 0. Transaction splitting can be enabled when the consistency level is 1 or 2.	{"ConsistLevel": "1","DistributedTransaction": "on"}
ClientToken	string	No	The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The token is generated by the client, must be unique across requests, is case-sensitive, and cannot exceed 64 ASCII characters in length.	6000170000591aed949d0f******************
DBEndpointDescription	string	No	The name of the custom cluster endpoint.	test
VPCId	string	No	The VPC ID.	vpc-2zehr7ghqovftils0****
VSwitchId	string	No	The vSwitch ID.	vsw-2ze775gnf7jn33ua****
SccMode	string	No	Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values: ON: enabled. OFF: disabled.	on
PolarSccWaitTimeout	string	No	The timeout period for global consistency.	100
PolarSccTimeoutAction	string	No	The timeout policy for global consistency. Valid values: 0: sends the request to the primary node. 2: timeout degradation. After a global consistency read times out, the query is automatically degraded to regular requests, and the client does not receive an error message.	0
PolarFsInstanceId	string	No	The PolarFs instance ID.	pfs-test****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CD35F3-F3-44CA-AFFF-BAF869******

Examples

Success response

JSON format

{
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ClusterEndpoint.StatusNotValid	Cluster endpoint status is not valid.	The state of the cluster endpoint is invalid.
400	EndpointNum.Error	Endpoint number error.	The maximum number of endpoints is exceeded.
400	LockTimeout	The request processing has failed due to lock timeout.	Failed to process the request due to a lock timeout.
403	OperationDenied.InstanceType	The operation is not permitted due to instance type.	The operation is not allowed due to the instance type
404	EndpointConfig.Invalid	Endpoint config is invalid.	The advanced parameter of the cluster endpoint is invalid.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	EndpointConfig.Conflict	Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.	Endpoint the configuration is invalid, the CausalConsistRead should be a session because global consistency (high performance mode) for the node is enabled.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.