UpdateReadWritePolicy - 开启或关闭集群写入高可用特性-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateReadWritePolicy

update

*全部资源

*

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-oew1oxiro000f****

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	5A2CFF0E-5718-45B5-9D4D-70B3FF****
body	string	否	待更新的写入高可用配置，采用 JSON 字符串表示。	{"writeHa":true,"autoGeneratePk":true}

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
}

返回参数

名称	类型	描述	示例值
	object
Result	boolean	返回结果： true：开启或关闭写入高可用成功 false：开启或关闭写入高可用失败	true
RequestId	string	请求 ID。	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

示例

正常返回示例

JSON格式

{
  "Result": true,
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。