Cluster health API in Elasticsearch

Introduction

The Cluster Health API helps you check the overall health and status of your Elasticsearch cluster quickly.

You want to see if your Elasticsearch cluster is running well or has problems.

Before running heavy searches, you want to confirm the cluster is healthy.

You want to monitor cluster status automatically in your app or script.

You want to check if all nodes and shards are working properly.

You want to get a quick summary of cluster performance and availability.

Syntax

Elasticsearch

GET /_cluster/health

# Optional parameters:
GET /_cluster/health?level=cluster|indices|shards
GET /_cluster/health?wait_for_status=green|yellow|red&timeout=30s

Use GET /_cluster/health to get the overall cluster health.

You can add parameters like level to get more details or wait_for_status to wait until the cluster reaches a certain health.

Examples

Get the overall health status of the cluster.

Elasticsearch

GET /_cluster/health

Get health status for each index in the cluster.

Elasticsearch

GET /_cluster/health?level=indices

Wait up to 30 seconds for the cluster to become green (fully healthy).

Elasticsearch

GET /_cluster/health?wait_for_status=green&timeout=30s

Sample Program

This Python program sends a request to the Cluster Health API and prints the cluster health details as JSON.

Elasticsearch

import requests

# URL of your Elasticsearch cluster
url = 'http://localhost:9200/_cluster/health'

# Send GET request to Cluster Health API
response = requests.get(url)

# Print the JSON response
print(response.json())

Important Notes

The cluster health status can be green (all good), yellow (some replicas not assigned), or red (some data missing).

Use the wait_for_status parameter to pause your request until the cluster reaches a desired health.

Checking cluster health regularly helps avoid surprises in your Elasticsearch setup.

Summary

The Cluster Health API shows the current health of your Elasticsearch cluster.

You can get overall or detailed health info using parameters.

It helps you monitor and keep your cluster running smoothly.

Practice

1. What does the Elasticsearch Cluster Health API primarily provide?

easy

A. The current health status of the Elasticsearch cluster

B. The list of all documents in the cluster

C. The configuration settings of the cluster nodes

D. The query performance statistics

Solution

1. Step 1: Understand the purpose of Cluster Health API

   The Cluster Health API is designed to report the health status of the Elasticsearch cluster, such as green, yellow, or red status.

2. Step 2: Compare with other options

   Options B, C, and D relate to documents, configuration, and performance, which are not the main focus of the Cluster Health API.

3. Final Answer:

   The current health status of the Elasticsearch cluster -> Option A

4. Quick Check:

   Cluster Health API = Cluster health status [OK]

Hint: Cluster Health API shows cluster status, not data or config [OK]

Common Mistakes:

• Confusing cluster health with document data
• Thinking it shows node configuration
• Assuming it reports query stats

2. Which of the following is the correct syntax to get the cluster health using Elasticsearch REST API?

easy

A. GET /_cluster/health

B. POST /_cluster/health

C. GET /_cluster/status

D. POST /_health/cluster

Solution

1. Step 1: Recall the correct HTTP method and endpoint

   The Cluster Health API uses the GET method with the endpoint /_cluster/health.

2. Step 2: Eliminate incorrect options

   POST is not used for this API, and the endpoint must be exactly /_cluster/health. Options C and D have wrong endpoints.

3. Final Answer:

   GET /_cluster/health -> Option A

4. Quick Check:

   GET + /_cluster/health = Correct syntax [OK]

Hint: Use GET method with /_cluster/health endpoint [OK]

Common Mistakes:

• Using POST instead of GET
• Wrong endpoint like /_cluster/status
• Mixing endpoint parts

3. What will be the output status if the cluster has all primary and replica shards allocated properly?

medium

A. "status": "red"

B. "status": "yellow"

C. "status": "blue"

D. "status": "green"

Solution

1. Step 1: Understand cluster health statuses

   Green means all primary and replica shards are allocated properly, yellow means replicas missing but primaries allocated, red means some primaries missing.

2. Step 2: Match the condition to status

   Since all primary and replica shards are allocated, the status is green.

3. Final Answer:

   "status": "green" -> Option D

4. Quick Check:

   All shards allocated = green status [OK]

Hint: Green means all shards allocated, yellow means some replicas missing [OK]

Common Mistakes:

• Confusing yellow with green
• Thinking red means healthy
• Assuming blue is a valid status

4. You run GET /_cluster/health?level=shards but get an error. What is the likely cause?

medium

A. The query parameter should be detail=shards instead

B. The HTTP method should be POST, not GET

C. The level parameter does not accept 'shards' as a value

D. The endpoint should be /_cluster/status

Solution

1. Step 1: Check valid values for level parameter

   The Cluster Health API accepts level values like 'cluster', 'indices', and 'shards'. However, 'shards' is only supported in newer versions and may cause errors if unsupported.

2. Step 2: Analyze other options

   GET is correct method, endpoint is correct, and detail is not a valid parameter for this API.

3. Final Answer:

   The level parameter does not accept 'shards' as a value -> Option C

4. Quick Check:

   Invalid level value causes error [OK]

Hint: Check if 'level=shards' is supported in your Elasticsearch version [OK]

Common Mistakes:

• Using POST instead of GET
• Wrong endpoint /_cluster/status
• Using invalid query parameters

5. You want to monitor your cluster health and get detailed info about each index's health. Which API call should you use?

hard

A. GET /_cluster/health?level=cluster

B. GET /_cluster/health?level=indices

C. GET /_cluster/state?filter_path=metadata.indices

D. GET /_nodes/stats

Solution

1. Step 1: Identify the parameter for detailed index health

   The level=indices parameter in the Cluster Health API returns health info for each index.

2. Step 2: Compare with other options

   level=cluster gives overall cluster health only; /_cluster/state and /_nodes/stats provide different info unrelated to health per index.

3. Final Answer:

   GET /_cluster/health?level=indices -> Option B

4. Quick Check:

   Use level=indices for per-index health details [OK]

Hint: Use level=indices to get health info per index [OK]

Common Mistakes:

• Using level=cluster for detailed index info
• Confusing cluster state with health API
• Requesting node stats instead of health