調用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. | 當前節點狀態不支持此操作 |
訪問錯誤中心查看更多錯誤碼。