創建PolarDB自定義集群地址。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 | pc-************** |
EndpointType | string | 是 | 自定義集群地址類型,取值固定為 Custom。 | Custom |
Nodes | string | 否 | 加入目標地址的讀負載節點,多個節點間用英文逗號(,)分隔。 默認為全部節點。 說明
Writer,Reader1,Reader2 。 | pi-**********,pi-********* |
ReadWriteMode | string | 否 | 讀寫模式,取值范圍如下:
| ReadOnly |
AutoAddNewNodes | string | 否 | 新節點是否自動加入本地址,取值范圍如下:
| Disable |
EndpointConfig | string | 否 | 集群地址的高級配置,格式為 JSON,目前支持設置一致性級別、事務拆分、主庫不接受讀和連接池。
說明
{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"} 。 | {"ConsistLevel": "1","DistributedTransaction": "on"} |
ClientToken | string | 否 | 用于保證請求的冪等性,防止重復提交請求。由客戶端生成該參數值,保證在不同請求間唯一,大小寫敏感、不超過 64 個 ASCII 字符。 | 6000170000591aed949d0f****************** |
DBEndpointDescription | string | 否 | 自定義集群地址名稱。 | test |
SccMode | string | 否 | 節點是否開啟全局一致性(高性能模式)功能。取值范圍如下:
枚舉值:
| on |
PolarSccWaitTimeout | string | 否 | 全局一致性超時時間 | 100 |
PolarSccTimeoutAction | string | 否 | 全局一致性超時策略。取值范圍如下:
| 0 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "CD35F3-F3-44CA-AFFF-BAF869******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ClusterEndpoint.StatusNotValid | Cluster endpoint status is not valid. | 集群地址的狀態無效. |
400 | EndpointNum.Error | Endpoint number error. | Endpoint數量超過限制 |
400 | LockTimeout | The request processing has failed due to lock timeout. | 由于鎖定超時,請求處理失敗 |
404 | EndpointConfig.Invalid | Endpoint config is invalid. | 集群地址的高級配置參數無效 |
404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的 DBClusterId。 |
404 | EndpointConfig.Conflict | Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled. | Endpoint配置無效,CausalConsistRead應為會話,因為節點的全局一致性(高性能模式)已啟用。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-30 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2022-11-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-09-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-07-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-04-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |