调用ModifyDBClusterEndpoint接口修改PolarDB的集群地址属性,包括读写模式、新节点是否自动加入本地址、一致性级别、事务拆分、主库是否接受读、连接池等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyDBClusterEndpoint | 系统规定参数。取值:ModifyDBClusterEndpoint。 |
DBClusterId | String | 是 | pc-************* | 集群ID。 |
DBEndpointId | String | 是 | pe-************** | 集群地址ID。 |
Nodes | String | 否 | pi-**************,pi-************* | 加入目标地址的读负载节点,多个节点间用英文逗号(,)分隔。 默认为原有节点。 说明
|
ReadWriteMode | String | 否 | ReadWrite | 读写模式,取值范围如下:
|
AutoAddNewNodes | String | 否 | Enable | 新节点是否自动加入本地址,取值范围如下:
|
EndpointConfig | String | 否 | {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"} | 集群地址的高级配置,格式为JSON,目前支持设置一致性级别、事务拆分、主库是否接受读和连接池等。
说明
|
DBEndpointDescription | String | 否 | test | 地址名称。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | CD3FA5F3-FAF3-44CA-AFFF-BAF869****** | 请求ID。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterEndpoint
&DBClusterId=pc-*************
&DBEndpointId=pe-**************
&Nodes=pi-**************,pi-*************
&ReadWriteMode=ReadWrite
&AutoAddNewNodes=Enable
&EndpointConfig={"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
&DBEndpointDescription=test
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyDBClusterEndpointResponse>
<RequestId>CD3FA5F3-FAF3-44CA-AFFF-BAF869******</RequestId>
</ModifyDBClusterEndpointResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "CD3FA5F3-FAF3-44CA-AFFF-BAF869******"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidEndpointConfig.Malformed | The specified parameter EndpointConfig is not valid. | 指定的参数EndpointConfig无效 |
400 | InvalidDBEndpointId.Malformed | The specified parameter DBEndpointId is not valid. | 指定的参数DBEndpointId无效 |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
404 | EndpointStatus.NotSupport | Current endpoint status does not support this operation. | 当前节点状态不支持此操作 |
访问错误中心查看更多错误码。