Skip to content

Commit fc90356

Browse files
committed
add cluster_get_settings
1 parent 7f81979 commit fc90356

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -893,8 +893,8 @@ npm run docs:dev
893893
- cat trained model
894894
- cat transforms
895895
- :heavy_check_mark: 集群API [:link:](https://elasticsearch.bookhub.tech/rest_apis/rest_apis/cluster_apis)
896-
- Cluster allocation explain
897-
- Cluster get settings
896+
- :heavy_check_mark: 集群分配解释 API [:link:](https://elasticsearch.bookhub.techrest_apis/cluster_apis/cluster_allocation_explain)
897+
- :heavy_check_mark: 集群获取设置 API [:link:](https://elasticsearch.bookhub.techrest_apis/cluster_apis/cluster_get_setting)
898898
- Cluster health
899899
- Cluster reroute
900900
- Cluster state

docs/rest_apis/cluster_apis/cluster_get_settings.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,29 @@
1010
GET /_cluster/settings
1111
```
1212

13+
## 前置条件
14+
15+
- 如果 Elasticsearch 安全特性启用,你必须有 `monitor``manage`[集群权限](/secure_the_elastic_statck/user_authorization/security_privileges#集群权限)以使用此 API。
16+
17+
## 请求
18+
19+
```bash
20+
GET /_cluster/settings
21+
```
22+
23+
## 描述
24+
25+
默认情况下,该 API 调用只返回已明确定义的设置,但也可以通过调用 `include_defaults` 参数来包含默认设置。
26+
27+
## 查询参数
28+
29+
- `flat_settings`
30+
(可选,布尔值) 如果为 `true`,则以平面格式返回设置。默认为 `false`
31+
32+
- `include_defaults`
33+
(可选,布尔) 如果为 `true`,则返回本地节点的默认集群设置。默认为 `false`
34+
35+
- `master_timeout`
36+
(可选,[时间单位](/rest_apis/api_convention/common_options.html#时间单位))等待主节点的时间。如果在超时前主节点不可用,则请求失败并返回错误。默认为 `30s`。也可以设置为 `-1`,表示请求永不超时。
37+
1338
> [原文链接](https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-get-settings.html)

sidebars.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,8 @@ const sidebars = {
156156
label: '集群 API',
157157
link: { type: 'doc', id: "rest_apis/cluster_apis/cluster_apis" },
158158
items: [
159-
"rest_apis/cluster_apis/cluster_allocation_explain"
159+
"rest_apis/cluster_apis/cluster_allocation_explain",
160+
"rest_apis/cluster_apis/cluster_get_setting"
160161
]
161162
},
162163
{

0 commit comments

Comments
 (0)