UpdateInstanceSettings - 修改实例的YML参数配置-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

接口说明

调用该接口时，请注意：
实例状态为生效中（activating）、失效（invalid）和冻结（inactive）时，无法更新配置。

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

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateInstanceSettings

update

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

无

PATCH /openapi/instances/{InstanceId}/instance-settings HTTP/1.1

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

名称	类型	必填	描述	示例值
updateStrategy	string	否	Elasticsearch 的变更策略（例如，索引更新、集群升级、服务部署时的变更方式）。取值如下： blue_green：蓝绿变更，可通过并行运行两个完全相同的环境（蓝环境和绿环境），实现无缝切换。 normal：原地变更，直接在当前环境进行变更（例如，升级、扩缩容），无需额外资源。 intelligent：智能变更，系统根据变更类型和环境状态自动分析，动态选择最优变更方式（即蓝绿变更或原地变更）。	normal
clientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	5A2CFF0E-5718-45B5-9D4D-70B3FF****
body	object	否	指定待更新的 YML 参数的值。	{ "esConfig": { "thread_pool.write.queue_size": 500 } }
esConfig	object	否	实例的 YML 文件配置信息。
	string	否	指定待更新的 YML 参数的 key	thread_pool.write.queue_size
force	boolean	否	是否强制变更

RequestBody 中还需填入 esConfig 参数，用来指定待更新的 YML 参数的值。关于 YML 参数的更多信息，请参见配置 YML 参数。

调整文档写入队列大小，以下示例适用于阿里云 Elasticsearch 6.x、7.x 及 8.x 版本。

{
    "esConfig": {
        "thread_pool.write.queue_size": 500
    }
}

返回数据中还包括 Result 参数，详情请参见 ListInstance 。

正常返回示例

JSON格式

{
  "RequestId": "BB1C321A-211C-4FD7-BD8B-7F2FABE2****"
}

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

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