PolarDB:ModifyDBClusterEndpointZonal

The cluster ID.

The ID of the cluster endpoint.

The read-only nodes to add to the endpoint. Separate multiple node IDs with commas (,). If you do not specify this parameter, the original nodes are retained.

The read/write mode. Valid values:

• ReadWrite: read-write (automatic read/write splitting)

• ReadOnly: read-only

Specifies whether to automatically add new nodes to this endpoint. Valid values:

• Enable: yes

• Disable: no (default)

The advanced configurations of the cluster endpoint, which are specified in the JSON format. You can set the consistency level, transaction splitting, whether the primary node accepts read requests, the connection pool, and more.

• To set the load balancing policy, use the format {\"LoadBalancePolicy\":\"policy\"}. Valid values:

  • 0: connection-based load balancing (default)

  • 1: active request-based load balancing

• To specify whether the primary node accepts read requests, use the format {\"MasterAcceptReads\":\"value\"}. Valid values:

  • on: The primary node accepts read requests (default).

  • off: The primary node does not accept read requests.

• To configure transaction splitting, use the format {\"DistributedTransaction\":\"value\"}. Valid values:

  • on: enables transaction splitting (default)

  • off: disables transaction splitting

• To set the consistency level, use the format {\"ConsistLevel\":\"level\"}. Valid values:

  • 0: eventual consistency (weak)

  • 1: session consistency (medium) (default)

  • 2: global consistency (strong)

• To set the timeout period for a global consistency read, use the format {\"ConsistTimeout\":\"timeout\"}. Valid values: 0 to 60000. Default value: 20. Unit: ms.

• To set the timeout period for a session consistency read, use the format {\"ConsistSessionTimeout\":\"timeout\"}. Valid values: 0 to 60000. Default value: 0. Unit: ms.

• To set the policy for a global or session consistency read timeout, use the format {\"ConsistTimeoutAction\":\"policy\"}. Valid values:

  • 0: Sends the read request to the primary node (default).

  • 1: The proxy returns a `wait replication complete timeout, please retry` error message to the application.

• To configure the connection pool, use the format {\"ConnectionPersist\":\"pool_type\"}. Valid values:

  • off: disables the connection pool (default)

  • Session: enables the session-level connection pool

  • Transaction: enables transaction-level connection pooling

• To configure parallel queries, use the format {\"MaxParallelDegree\":\"value\"}. Valid values:

  • on: enables parallel queries

  • off: disables parallel queries (default)

• To configure automatic routing between row store and column store, use the format {\"EnableHtapImci\":\"value\"}. Valid values:

  • on: enables automatic routing between row store and column store

  • off: disables automatic routing between row store and column store (default)

• To specify whether to enable overload protection, use the format {\"EnableOverloadThrottle\":\"value\"}. Valid values:

  • on: enables overload protection

  • off: disables overload protection (default)

The name of the endpoint.

Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:

• ON: enables the feature

• OFF: disables the feature

The timeout period for global consistency.

The policy for a global consistency timeout. Valid values:

• 0: Sends the request to the primary node.

• 2: Timeout degradation. If a global consistency read times out, the query is automatically downgraded to a regular request, and the client does not receive an error message.

A client token to ensure the idempotence of the request. The client generates the value, but you must make sure that the value is unique among different requests. The token is case-sensitive and can contain up to 64 ASCII characters.