Cluster health API in Elasticsearch - Mini Project: Build & Apply

Cluster health API

📖 Scenario: You are managing an Elasticsearch cluster and want to check its health status programmatically.

🎯 Goal: Build a simple script that queries the Elasticsearch Cluster Health API and displays the cluster's status.

📋 What You'll Learn

Create a variable with the Elasticsearch cluster URL

Create a variable for the health status level to check (e.g., 'green')

Use the Cluster Health API to get the cluster status

Print the cluster status

💡 Why This Matters

🌍 Real World

Checking cluster health is important to ensure Elasticsearch is running smoothly and data is available.

💼 Career

System administrators and DevOps engineers often write scripts to monitor Elasticsearch clusters and alert teams if problems occur.

1

Set up the Elasticsearch cluster URL

Create a variable called cluster_url and set it to "http://localhost:9200/_cluster/health".

Elasticsearch

cluster_url = "http://localhost:9200/_cluster/health"
# Your code here

Need a hint?

Use a string variable to store the full URL for the cluster health API.

2

Set the health status level to check

Create a variable called desired_status and set it to "green".

Elasticsearch

cluster_url = "http://localhost:9200/_cluster/health"
desired_status = "green"
# Your code here

Need a hint?

This variable will hold the health status level you want to check for.

3

Query the Cluster Health API

Use the requests library to send a GET request to cluster_url and store the JSON response in a variable called health_data. You must import requests first.

Elasticsearch

import requests

cluster_url = "http://localhost:9200/_cluster/health"
desired_status = "green"

# Your code here

Need a hint?

Use requests.get() to call the API and .json() to parse the response.

4

Print the cluster health status

Print the cluster health status from health_data["status"] using print().

Elasticsearch

import requests

cluster_url = "http://localhost:9200/_cluster/health"
desired_status = "green"

response = requests.get(cluster_url)
health_data = response.json()

# Your code here

Need a hint?

Use print(health_data["status"]) to show the cluster status.