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