UpdateReadWritePolicy
开启或关闭集群的写入高可用特性。目前仅支持华北2(北京)区域的实例
服务地址:
华东1 金融云
输入参数
只看必填
InstanceId实例ID
body
幂等性参数
ClientToken用于保证请求的幂等性
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求语法

POST /openapi/instances/{InstanceId}/actions/update-read-write-policy HTTP/1.1

路径参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:es-cn-oew1oxiro000f****参考取值来源:
    ListInstance

请求参数

字段名称字段详情
ClientTokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring

请求说明

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
}

返回参数

字段名称字段详情
Resultboolean

返回结果:展开详情

示例值:true
RequestIdstring

请求 ID。

示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
变更历史
暂无变更历史