調用UpdateReadWritePolicy，開啟或關閉集群的寫入高可用特性。目前僅支持華北2（北京）區域的實例。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。
請求語法
POST /openapi/instances/[InstanceId]/actions/update-read-write-policy HTTP/1.1請求參數
| 名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|---|
| InstanceId | String | Path | 是 | es-cn-oew1oxiro000f**** |
實例ID。 |
| ClientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
用于保證請求的冪等性。由客戶端生成該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字符。 |
RequestBody
RequestBody中還需填入以下參數，用來指定高可用特性的參數配置。
|
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
|---|---|---|---|---|
|
writeHa |
Boolean |
否 |
true |
是否開啟寫入高可用特性。true表示是，false表示否。 |
|
autoGeneratePk |
Boolean |
否 |
true |
無主鍵時，是否自動生成文檔哈希值主鍵。true為默認值，表示自動生成主鍵；false表示不會自動生成主鍵。 autoGeneratePk不可單獨修改，只有在writeHa從false更新為true的時候，同時設置autoGeneratePk才生效。 |
|
writePolicy |
String |
否 |
sync |
設置臨時切換同步和異步高可用。只有在開通高可用，即writeHa為true的情況下，設置此字段才有效。設置此字段時不需要同時傳入writeHa字段。 可選值： sync：臨時由異步寫入高可用切換為同步。 async：臨時開啟同步寫入后，恢復異步寫入高可用。 |
示例如下。
{
"writeHa":true,
"autoGeneratePk":true
}
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** |
請求ID。 |
| Result | Boolean | true |
返回結果：
|
示例
請求示例
POST /openapi/instances/es-cn-oew1oxiro000f****/actions/update-read-write-policy HTTP/1.1
公共請求頭
{
"writeHa":true,
"autoGeneratePk":true
}正常返回示例
JSON格式
{
"RequestId": "E29B6B26-1040-4829-972D-3D6459A5****",
"Result": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。