该接口用于修改PolarDB的集群地址属性,包括读写模式、新节点是否自动加入本地址、一致性级别、事务拆分、主库不接受读、PHP短连接优化等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyDBClusterEndpoint

系统规定参数,取值:ModifyDBClusterEndpoint

DBClusterId String pc-xxxxxxxxxxxxxxxxxx

集群ID。

DBEndpointId String pe-xxxxxxxx

集群地址ID。例如pe-xxxxxxxx。

Nodes String pi-xxxxxxxxxx,pi-xxxxxxxxxx

加入本地址用于处理读请求的节点,用(,)分隔,至少两个。

默认为原有节点。

ReadWriteMode String ReadWrite

读写模式:

  • ReadWrite:可读可写(自动读写分离)。
  • ReadOnly:只读。

默认为ReadOnly

AutoAddNewNodes String Enable

新节点是否自动加入本地址,取值:

  • Enable
  • Disable

默认为Disable

EndpointConfig String {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}

集群地址的高级配置,格式为JSON,目前支持设置一致性级别、事务拆分、主库不接受读和PHP短连接优化。

说明 仅PolarDB MySQL支持设置事务拆分、主库不接受读和PHP短连接优化。

设置一致性级别,格式为{"ConsistLevel": "一致性级别"}

一致性级别取值为:

  • 0:最终一致性。
  • 1:会话一致性(默认值)。
  • 2:全局一致性。

设置事务拆分,格式为{"DistributedTransaction": "事务拆分设置"}

事务拆分设置取值为:

  • on:开启事务拆分(默认值)。
  • off:关闭事务拆分。

设置主库不接受读,格式为{"MasterDoNotAcceptReads":"主库不接受读"}

主库不接受读取值为:

  • on:关闭,表示主库接受读。
  • off:开启(默认值),表示主库不接受读。

设置PHP短连接优化,格式为{"ConnectionPersist": "PHP短连接优化"}

PHP短连接优化取值为:

  • on:开启短连接优化。
  • off:关闭短连接优化(默认值)。
说明
  • 仅PolarDB MySQL支持一致性级别设置为全局一致性。
  • 如果参数ReadWriteMode取值为ReadOnly,一致性级别取值只能为0
  • 您可以同时设置一致性级别、事务拆分、主库不接受读和PHP短连接优化,例如{"ConsistLevel": "1","DistributedTransaction": "on","MasterDoNotAcceptReads":"1","ConnectionPersist": "on"}
  • 事务拆分的设置受一致性级别设置的约束。例如一致性级别取值为0时,不支持开启事务拆分;一致性级别取值为12时,支持开启事务拆分。
  • 目前仅支持默认集群地址设置PHP短连接优化。

返回数据

名称 类型 示例值 描述
RequestId String CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyDBClusterEndpoint
&DBClusterId=pc-xxxxxxxxxxxxxxxxxx
&DBEndpointId=pe-xxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<ModifyDBClusterEndpointResponse>  
      <RequestId>CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B</RequestId>
</ModifyDBClusterEndpointResponse>

JSON 格式

{
    "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B"
}

错误码

访问错误中心查看更多错误码。