health
返回集群的健康状态。集群健康用三种颜色表示:green、yellow和red。green表示所有分片都已分配。yellow表示主分片已分配,但是副本分片没有分配。red表示主分片和副本分片都没有分配。索引的状态由最差的分片状态决定。集群的状态由最差的索引状态决定。此API的优点是能够等到集群达到一定水平的健康状态的能力。health接受一个可选的路径参数:逗号分隔的索引名列表,接受通配符表达式。
查询参数
参数 | 说明 |
level | 控制返回健康信息的详细程度,可选值为cluster、indices和shards,默认为cluster。 |
local | 如果为true,则只从本地节点返回信息,否则从主节点返回信息。默认为false。 |
timeout | 指定等待响应的时间。如果超时则请求失败并返回错误。默认30s。 |
master_timeout | 连接主节点的超时时间。如果超时则请求失败并返回错误。默认30s。 |
wait_for_active_shards | 等待多少分片变为活跃状态,all表示等待所有分片变为活跃状态,0表示不等待。默认为0。 |
wait_for_events | 等待到指定优先级的队列事件处理完,可选值为immediate、urgent、 high、normal、low和languid。 |
wait_for_no_initializing_shards | 是否等待到集群没有分片初始化。默认为false,不等待分片初始化。 |
wait_for_no_relocating_shards | 是否等待到集群没有分片重定位。默认为false,不等待分片重定位。 |
wait_for_nodes | 等待到有指定数量的节点可用。参数值除整数外,还可以是>=N、>N、<=N和<N或者ge(N)、le(N)、gt(N)和lt(N)来指定范围。 |
wait_for_status | 等待到集群的状态等于或好于指定的状态。green>yellow>red。默认情况下不会等待。 |
返回信息
字段 | 说明 |
cluster_name | 集群名。 |
status | 集群状态。 |
timed_out | 如果为false,表示在超时时间内返回结果。 |
number_of_nodes | 集群中的节点数。 |
number_of_data_nodes | 集群中的数据节点数。 |
active_primary_shards | 活跃的主分片数。 |
active_shards | 活跃的分片数。 |
relocating_shards | 正在重定位的分片数。 |
initializing_shards | 正在初始化的分片数。 |
unassigned_shards | 未分配的分片数。 |
delayed_unassigned_shards | 被超时设置延迟分配的分片数。 |
number_of_pending_tasks | 尚未执行的集群级更改的数量。 |
number_of_in_flight_fetch | 未完成读取的数量。 |
task_max_waiting_in_queue_millis | 自最早发起任务以来等待执行的时间的毫秒表示。 |
active_shards_percent_as_number | 集群中活跃分片的百分比。 |