Skip to content

Commit 479b076

Browse files
committed
更新赞赏;add cluster_health
1 parent fc90356 commit 479b076

File tree

4 files changed

+453
-252
lines changed

4 files changed

+453
-252
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
![license](https://img.shields.io/badge/license-CC--BY--NC-%2321BAB5)
44

5-
## 注意❗
5+
## 注意
66

77
目前发现新版本官方文档结构和内容发生了大调整,计划在当前版本内容翻译完成后,调整文档目录结构。
88

99
后续计划如下:
1010

1111
1. 继续翻译 8.x 版本的文档内容
1212
1. 完成后,将已完成内容将放到**历史**目录下
13-
2. 翻译官方 9.x 版本文档内容作为主要内容
13+
1. 翻译官方 9.x 版本文档内容作为主要内容
1414

1515
## 目录
1616

@@ -21,7 +21,6 @@
2121
- [公众号](#微信公众号)
2222
- [翻译进度](#文档列表及进度)
2323

24-
2524
## 翻译目标及说明
2625

2726
### 说明
@@ -60,21 +59,22 @@
6059

6160
### 赞赏榜
6261

63-
> 感谢赞赏和点击广告的朋友,你们的支持可能让我继续坚持下去。域名我已经买了10年了
62+
> 感谢赞赏和点击广告的朋友,你们的支持可能让我继续坚持下去。域名我已经买了 10 年了
6463
65-
|昵称|时间|赞赏|留言|
66-
|--|--|--|--|
67-
|leorn****|2024.10.30 01:16|¥10.24|--|
68-
|土豆****|2024.06.26 20:28|¥10.24|--|
69-
|o_****|2024.05.11 09:46|¥2.33|**感谢翻译**|
70-
|小f****|2024.04.03 16:25|¥2.33|--|
71-
|【未知】|2024.03.29 08:27|¥6.66|--|
72-
|【未知】|2024.03.20 09:57|¥6.66|**感谢大佬解救英语苦手**|
73-
|【未知】|2023.09.18 20:36|¥6.66|**加油**|
74-
|****|2023.04.15 10:43|¥0.50|--|
75-
|gr****|2022.07.17 10:22|¥6.66|--|
76-
|55****|2022.03.03 19:21|¥1.00|--|
77-
|zs****|2022.03.03 15:43|¥1.00|--|
64+
| 昵称 | 时间 | 赞赏 | 留言 |
65+
| ------------- | ----------------- | -------- | ------------------------ |
66+
| biw\*\* | 2025.07.01 11:42 | ¥ 6.66 | **感谢翻译** |
67+
| leorn\*\*\*\* | 2024.10.30 01:16 | ¥ 10.24 | -- |
68+
| 土豆\*\*\*\* | 2024.06.26 20:28 | ¥ 10.24 | -- |
69+
| o\_\*\*\*\* | 2024.05.11 09:46 | ¥ 2.33 | **感谢翻译** |
70+
| 小 f\*\*\*\* | 2024.04.03 16:25 | ¥ 2.33 | -- |
71+
| 【未知】 | 2024.03.29 08:27 | ¥ 6.66 | -- |
72+
| 【未知】 | 2024.03.20 09:57 | ¥ 6.66 | **感谢大佬解救英语苦手** |
73+
| 【未知】 | 2023.09.18 20:36 | ¥ 6.66 | **加油** |
74+
|\*\*\*\* | 2023.04.15 10:43 | ¥ 0.50 | -- |
75+
| gr\*\*\*\* | 2022.07.17 10:22 | ¥ 6.66 | -- |
76+
| 55\*\*\*\* | 2022.03.03 19:21 | ¥ 1.00 | -- |
77+
| zs\*\*\*\* | 2022.03.03 15:43 | ¥ 1.00 | -- |
7878

7979
## 微信公众号
8080

@@ -115,7 +115,7 @@ npm run docs:dev
115115
- :heavy_check_mark: 启动并运行 Elasticsearch [:link:](https://elasticsearch.bookhub.tech/getting_started/install.html)
116116
- :heavy_check_mark: 索引一些文档 [:link:](https://elasticsearch.bookhub.tech/getting_started/docs_index.html)
117117
- :heavy_check_mark: 开始搜索 [:link:](https://elasticsearch.bookhub.tech/getting_started/search.html)
118-
- :heavy_check_mark: 使用聚合分析结果 [:link:](https://elasticsearch.bookhub.tech/getting_started/aggregations.html)
118+
- :heavy_check_mark: 使用聚合分析结果 [:link:](https://elasticsearch.bookhub.tech/getting_started/aggregations.html)
119119
- :heavy_check_mark: 何去何从 [:link:](https://elasticsearch.bookhub.tech/getting_started/nextstep.html)
120120
- :heavy_check_mark: 设置 Elasticsearch [:link:](https://elasticsearch.bookhub.tech/set_up_elasticsearch/)
121121
- :heavy_check_mark: 安装 Elasticsearch [:link:](https://elasticsearch.bookhub.tech/set_up_elasticsearch/installing_elasticsearch/)
@@ -211,10 +211,10 @@ npm run docs:dev
211211
- :heavy_check_mark: 索引级分片分配过滤 [:link:](https://elasticsearch.bookhub.tech/index_modules/index_shard_allocation/shard_allocation_filtering.html)
212212
- :heavy_check_mark: 当节点离开时延迟分配 [:link:](https://elasticsearch.bookhub.tech/index_modules/index_shard_allocation/delaying_allocation.html)
213213
- :heavy_check_mark: 索引恢复优先级 [:link:](https://elasticsearch.bookhub.tech/index_modules/index_shard_allocation/index_recovery_prioritization.html)
214-
- :heavy_check_mark: 每节点分片总数 [:link:](https://elasticsearch.bookhub.tech/index_modules/index_shard_allocation/total_shards_per_node.html)
214+
- :heavy_check_mark: 每节点分片总数 [:link:](https://elasticsearch.bookhub.tech/index_modules/index_shard_allocation/total_shards_per_node.html)
215215
- :heavy_check_mark: 索引级数据层分配过滤 [:link:](https://elasticsearch.bookhub.tech/index_modules/index_shard_allocation/data_tier_allocation_filtering.html)
216216
- :heavy_check_mark: 索引块 [:link:](https://elasticsearch.bookhub.tech/index_modules/index_blocks.html)
217-
- :heavy_check_mark: 映射器 [:link:](https://elasticsearch.bookhub.tech/index_modules/mapper.html)
217+
- :heavy_check_mark: 映射器 [:link:](https://elasticsearch.bookhub.tech/index_modules/mapper.html)
218218
- Merge
219219
- Similarity module
220220
- Slow Log
@@ -892,10 +892,10 @@ npm run docs:dev
892892
- cat thread pool
893893
- cat trained model
894894
- cat transforms
895-
- :heavy_check_mark: 集群API [:link:](https://elasticsearch.bookhub.tech/rest_apis/rest_apis/cluster_apis)
895+
- :heavy_check_mark: 集群 API [:link:](https://elasticsearch.bookhub.tech/rest_apis/rest_apis/cluster_apis)
896896
- :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)
898-
- Cluster health
897+
- :heavy_check_mark: 集群获取设置 API [:link:](https://elasticsearch.bookhub.techrest_apis/cluster_apis/cluster_get_settings)
898+
- :heavy_check_mark: 集群健康 API [:link:](https://elasticsearch.bookhub.techrest_apis/cluster_apis/cluster_health)
899899
- Cluster reroute
900900
- Cluster state
901901
- Cluster stats

docs/intro.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ slug: /
1414

1515
从官方版本 7.11 文档开始,当前版本为 8.13。由于官方版本更新比较快,文档虽然是基于 7.11 开始翻译,,实际翻译过程中,后续的文档都是翻译当前的最新版本。
1616

17-
## 注意❗
17+
## 注意
1818

1919
目前发现新版本官方文档结构和内容发生了大调整,计划在当前版本内容翻译完成后,调整文档目录结构。
2020

2121
后续计划如下:
2222

2323
1. 继续翻译 8.x 版本的文档内容
2424
1. 完成后,将已完成内容将放到**历史**目录下
25-
2. 翻译官方 9.x 版本文档内容作为主要内容
25+
1. 翻译官方 9.x 版本文档内容作为主要内容
2626

2727
## 微信公众号
2828

@@ -48,16 +48,17 @@ slug: /
4848

4949
> 感谢赞赏和关注广告的朋友,你们的支持可能让我继续坚持下去。
5050
51-
|昵称|时间|赞赏|留言|
52-
|--|--|--|--|
53-
|leorn****|2024.10.30 01:16|¥10.24|--|
54-
|土豆****|2024.06.26 20:28|¥10.24|--|
55-
|o_****|2024.05.11 09:46|¥2.33|**感谢翻译**|
56-
|小f****|2024.04.03 16:25|¥2.33|--|
57-
|【未知】|2024.03.29 08:27|¥6.66|--|
58-
|【未知】|2024.03.20 09:57|¥6.66|**感谢大佬解救英语苦手**|
59-
|【未知】|2023.09.18 20:36|¥6.66|**加油**|
60-
|****|2023.04.15 10:43|¥0.50|--|
61-
|gr****|2022.07.17 10:22|¥6.66|--|
62-
|55****|2022.03.03 19:21|¥1.00|--|
63-
|zs****|2022.03.03 15:43|¥1.00|--|
51+
| 昵称 | 时间 | 赞赏 | 留言 |
52+
| ------------- | ----------------- | -------- | ------------------------ |
53+
| biw\*\* | 2025.07.01 11:42 | ¥ 6.66 | **感谢翻译** |
54+
| leorn\*\*\*\* | 2024.10.30 01:16 | ¥ 10.24 | -- |
55+
| 土豆\*\*\*\* | 2024.06.26 20:28 | ¥ 10.24 | -- |
56+
| o\_\*\*\*\* | 2024.05.11 09:46 | ¥ 2.33 | **感谢翻译** |
57+
| 小 f\*\*\*\* | 2024.04.03 16:25 | ¥ 2.33 | -- |
58+
| 【未知】 | 2024.03.29 08:27 | ¥ 6.66 | -- |
59+
| 【未知】 | 2024.03.20 09:57 | ¥ 6.66 | **感谢大佬解救英语苦手** |
60+
| 【未知】 | 2023.09.18 20:36 | ¥ 6.66 | **加油** |
61+
|\*\*\*\* | 2023.04.15 10:43 | ¥ 0.50 | -- |
62+
| gr\*\*\*\* | 2022.07.17 10:22 | ¥ 6.66 | -- |
63+
| 55\*\*\*\* | 2022.03.03 19:21 | ¥ 1.00 | -- |
64+
| zs\*\*\*\* | 2022.03.03 15:43 | ¥ 1.00 | -- |
Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# 集群健康 API
2+
3+
:::info 新 API 参考
4+
有关最新 API 的详细信息,参阅[集群 API](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-cluster)
5+
:::
6+
7+
返回一个集群的健康状态。
8+
9+
## 请求
10+
11+
```bash
12+
GET /_cluster/health/<target>
13+
```
14+
15+
## 前置条件
16+
17+
- 如果 Elasticsearch 安全特性启用,你必须有 `monitor``manage`[集群权限](/secure_the_elastic_statck/user_authorization/security_privileges#集群权限)以使用此 API。
18+
19+
## 描述
20+
21+
集群健康 API 返回集群健康的简单状态。你还可以使用 API 仅获取指定数据流和索引的健康状况。对于数据流,API 会检索流的后备索引的健康状况。
22+
23+
集群健康状况分为:`green`(绿色)、`yellow`(黄色)或 `red`(红色)。在分片级别,`red`(红色)状态表示特定分片未在集群中分配,`yellow`(黄色)表示主分片已分配但副本未分配,`green`(绿色)表示所有分片均已分配。索引级状态由最差分区状态控制。集群状态由最差索引状态控制。
24+
25+
此 API 的主要优点之一是可以等待集群达到一定的高水位健康水平。例如,以下内容将等待 50 秒,等待集群达到黄色级别(如果在 50 秒后达到 `green`(绿色)或`yellow`(黄色)状态,则会在此时返回):
26+
27+
```bash
28+
GET /_cluster/health?wait_for_status=yellow&timeout=50s
29+
```
30+
31+
## 路径参数
32+
33+
- `<target>`
34+
35+
(可选,字符串) 用于限制请求的数据流、索引和索引别名的逗号分隔列表。支持通配符表达式 (`*`)。
36+
37+
要以集群中的所有数据流和索引为目标,请省略此参数或使用 `_all``*`
38+
39+
## 查询参数
40+
41+
- `level`
42+
43+
(可选,字符串) 可以是 `cluster`(集群)、`indices`(索引)或 `shards`(分片)之一。控制返回的健康信息的详细信息级别。默认为 `cluster`(集群)。
44+
45+
- `local`
46+
47+
(可选,布尔值) 如果为 `true`,则请求只从本地节点检索信息。默认为 `false`,表示从主节点获取信息。
48+
49+
- `master_timeout`
50+
51+
(可选,[时间单位](/rest_apis/api_convention/common_options.html#时间单位))等待连接到主节点的时间。如果在超时前主节点不可用,则请求失败并返回错误信息。默认值为 `30s`。也可以设置为 `-1`,表示请求永不超时。
52+
53+
- `timeout`
54+
55+
(可选,[时间单位](/rest_apis/api_convention/common_options.html#时间单位))更新集群元数据后等待集群中所有相关节点响应的时间。如果在超时前未收到任何响应,群集元数据更新仍将适用,但响应将显示未完全确认。默认为 `30s`。也可以设置为 `-1`,表示请求永不超时。
56+
57+
- `wait_for_active_shards`
58+
59+
(可选,字符串)一个数字,表示要等待多少个激活的分片,`all` 表示等待集群中所有分片都激活,`0` 表示不等待。默认为 `0`
60+
61+
- `wait_for_events`
62+
63+
(可选,字符串)可以是 `immediate``urgent``high``normal``low``languid`中的一个。等待当前队列中所有具有给定优先级的事件被处理完毕。
64+
65+
- `wait_for_no_initializing_shards`
66+
67+
(可选,布尔值)一个布尔值,用于控制是否等待(直到提供的超时时间)集群没有分片初始化。默认值为 `false`,即不等待分片初始化。
68+
69+
- `wait_for_no_relocating_shards`
70+
71+
(可选,布尔值)一个布尔值,用于控制是否等待(直到提供的超时时间)集群没有分片重定位。默认值为 `false`,即不等待分片重定位。
72+
73+
- `wait_for_nodes`
74+
75+
(可选,字符串)请求等待指定数量的 `N` 节点可用。它也接受 `>=N``<=N``>N``<N`。也可以使用 `ge(N)``le(N)``gt(N)``lt(N)` 符号。
76+
77+
- `wait_for_status`
78+
79+
(可选,字符串)`green`(绿色)、`yellow`(黄色)或 `red`(红色)之一。将等待(直到超时)群集的状态变为所提供的状态或更好的状态,即 `green`(绿色)> `yellow`(黄色) > red`(红色。默认情况下,不会等待任何状态。
80+
81+
## 响应体
82+
83+
- `cluster_name`
84+
85+
(字符串)集群的名称。
86+
87+
- `status`
88+
89+
(字符串)群集的健康状态,基于其主分片和副本分片的状态。状态包括:
90+
91+
- `green`:所有分区都已分配。
92+
- `yellow`: 所有主分片都已分配,但一个或多个副本分片未分配。如果集群中的一个节点发生故障,在该节点修复之前,一些数据可能无法使用。
93+
- `red`: 一个或多个主分区未分配,因此某些数据不可用。这种情况可能在群集启动期间主分区分配时短暂出现。
94+
95+
- `timed_out`
96+
97+
(布尔值)如果为 `false`,则在超时参数指定的时间内(默认为 `30s`)返回响应。
98+
99+
- `number_of_nodes`
100+
101+
(整数)集群内的节点数。
102+
103+
- `number_of_data_nodes`
104+
105+
(整数)专用数据节点的数量。
106+
107+
- `active_primary_shards`
108+
(整数)活动主分区的数量。
109+
110+
- `active_shards`
111+
112+
(整数)活动主分片和副本分片的总数。
113+
114+
- `relocating_shards`
115+
(整数)正在重新定位的分片数量。
116+
117+
- `initializing_shards`
118+
(整数) 正在初始化的分片数量。
119+
120+
- `unassigned_shards`
121+
(整数)未分配的分区数量。
122+
123+
- `unassigned_primary_shards`
124+
125+
(整数)主要但未分配的分片数量。**注意**:如果集群中包含运行低于 8.16 版本的节点,则该数字可能低于真实值。要在这种情况下获得更准确的计数,请使用集群健康 API。
126+
127+
- `delayed_unassigned_shards`
128+
129+
(整数)因超时设置而延迟分配的分片数量。
130+
131+
- `number_of_pending_tasks`
132+
(整数)尚未执行的群集级更改的数量。
133+
134+
- `number_of_in_flight_fetch`
135+
136+
(整数)未完成的获取次数。
137+
138+
- `task_max_waiting_in_queue_millis`
139+
140+
(整数)最早启动的任务等待执行的时间,以毫秒为单位。
141+
142+
- `active_shards_percent_as_number`
143+
144+
(浮点数)集群中活动分片的比例,以百分比表示。
145+
146+
## 示例
147+
148+
```bash
149+
GET _cluster/health
150+
```
151+
152+
如果单节点集群中只有一个索引,且只有一个分片和一个副本,API 会返回以下响应:
153+
154+
```json
155+
{
156+
"cluster_name": "testcluster",
157+
"status": "yellow",
158+
"timed_out": false,
159+
"number_of_nodes": 1,
160+
"number_of_data_nodes": 1,
161+
"active_primary_shards": 1,
162+
"active_shards": 1,
163+
"relocating_shards": 0,
164+
"initializing_shards": 0,
165+
"unassigned_shards": 1,
166+
"unassigned_primary_shards": 0,
167+
"delayed_unassigned_shards": 0,
168+
"number_of_pending_tasks": 0,
169+
"number_of_in_flight_fetch": 0,
170+
"task_max_waiting_in_queue_millis": 0,
171+
"active_shards_percent_as_number": 50.0
172+
}
173+
```
174+
175+
下面是一个在 `shards`(分片)级别获取集群健康状况的示例:
176+
177+
```bash
178+
GET /_cluster/health/my-index-000001?level=shards
179+
```
180+
181+
> [原文链接](https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-health.html)

0 commit comments

Comments
 (0)