集群设置
1.0 版引入
集群设置操作允许您检查集群的当前设置、查看默认设置和更改设置。当您使用 API 更新设置时，OpenSearch 会将其应用于集群中的所有节点。
端点
GET _cluster/settings
PUT _cluster/settings
路径参数
所有参数都是可选的。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| flat_settings | 布尔型 | 是否以扁平形式返回设置，这可以提高可读性，特别是对于深度嵌套的设置。例如，"cluster": { "max_shards_per_node": 500 } 的扁平形式是 "cluster.max_shards_per_node": "500"。 |
| include_defaults (仅限 GET) | 布尔型 | 是否在响应中包含默认设置。此参数对于识别您要更新的设置名称和当前值非常有用。 |
| cluster_manager_timeout | 时间单位 | 等待集群管理器节点响应的时间量。默认值为 30 秒。 |
| timeout (仅限 PUT) | 时间单位 | 等待集群响应的时间量。默认值为 30 秒。 |
请求正文字段
GET 操作没有请求正文字段。所有集群设置字段参数都是可选的。
并非所有集群设置都可以使用集群设置 API 进行更新。当尝试通过 API 配置这些设置时，您将收到错误消息 "setting [cluster.some.setting], not dynamically updateable"。
有关所有集群设置的列表，请参阅配置 OpenSearch。
示例请求
以下示例请求展示了如何使用集群设置 API。
检查默认集群设置
以下示例请求检查默认集群设置
GET _cluster/settings?include_defaults=true
更新集群设置
以下示例更新了 cluster.max_shards_per_node 设置。对于 PUT 操作，请求正文必须包含 transient 或 persistent，以及您要更新的设置
PUT _cluster/settings
{
"persistent":{
"cluster.max_shards_per_node": 500
}
}
有关临时设置、持久设置和优先级的更多信息，请参阅OpenSearch 配置。
示例响应
以下示例响应显示持久集群设置 max_shard_per_node 已更新
{
"acknowledged":true,
"persistent":{
"cluster":{
"max_shards_per_node":"500"
}
},
"transient":{}
}