API состояния кластера

GET /_cluster/health/<target>

API состояния кластера возвращает краткое состояние здоровья кластера. Также с помощью API можно получить состояние здоровья только указанных потоков данных и индексов. Для потоков данных API получает состояние здоровья базовых индексов потока.

Состояние здоровья кластера: green, yellow или red. На уровне фрагментов red означает, что фрагмент не выделен в кластере, yellow означает, что первичный фрагмент выделен, но реплики нет, а green означает, что все фрагменты выделены. Состояние на уровне индекса контролируется худшим состоянием фрагмента. Состояние кластера контролируется худшим состоянием индекса.

Одно из основных преимуществ API — возможность ожидания, пока кластер достигнет определённого уровня здоровья. Например, следующий код подождёт 50 секунд, пока кластер достигнет уровня yellow (если кластер достигнет состояния green или yellow раньше, чем через 50 секунд, он вернёт результат в этот момент):

$response = $client->cluster()->health();

resp = client.cluster.health(
    wait_for_status="yellow",
    timeout="50s",
)
print(resp)

response = client.cluster.health(
  wait_for_status: 'yellow',
  timeout: '50s'
)
puts response

res, err := es.Cluster.Health(
	es.Cluster.Health.WithTimeout(time.Duration(50000000000)),
	es.Cluster.Health.WithWaitForStatus("yellow"),
)
fmt.Println(res, err)

const response = await client.cluster.health({
  wait_for_status: "yellow",
  timeout: "50s",
});
console.log(response);

GET /_cluster/health?wait_for_status=yellow&timeout=50s

$response = $client->cluster()->health();

resp = client.cluster.health()
print(resp)

response = client.cluster.health
puts response

res, err := es.Cluster.Health()
fmt.Println(res, err)

const response = await client.cluster.health();
console.log(response);

GET _cluster/health

API возвращает следующий ответ в случае тихого кластера из одного узла с одним индексом, одной фрагментом и одной репликой:

{
  "cluster_name" : "testcluster",
  "status" : "yellow",
  "timed_out" : false,
  "number_of_nodes" : 1,
  "number_of_data_nodes" : 1,
  "active_primary_shards" : 1,
  "active_shards" : 1,
  "relocating_shards" : 0,
  "initializing_shards" : 0,
  "unassigned_shards" : 1,
  "unassigned_primary_shards" : 0,
  "delayed_unassigned_shards": 0,
  "number_of_pending_tasks" : 0,
  "number_of_in_flight_fetch": 0,
  "task_max_waiting_in_queue_millis": 0,
  "active_shards_percent_as_number": 50.0
}

Следующий пример получения состояния кластера на уровне shards:

resp = client.cluster.health(
    index="my-index-000001",
    level="shards",
)
print(resp)

response = client.cluster.health(
  index: 'my-index-000001',
  level: 'shards'
)
puts response

const response = await client.cluster.health({
  index: "my-index-000001",
  level: "shards",
});
console.log(response);

GET /_cluster/health/my-index-000001?level=shards