Elasticsearch Cluster APIs

In Elasticsearch, cluster API fetches the information about a cluster and its node. It also makes further changes in them. With the help of Cluster API, we can perform the 21 operations at the cluster level. We can use this API to manage our clusters. We need to specify node name, address or _local keyword along with the GET method to call this API.

As we said, this is a distributed environment where we have a lot of nodes and this Elasticsearch environment can be multi-node deployment as well. So, in this case, cluster API gives us information with respect to the cluster. Below some essential points of cluster API –

Most of the cluster APIs allows specifying which nodes to execute.
In APIs, we can identify the nodes either using their internal node name, node id, custom attributes, address, or just receiving _local node request.

For Example

Response

You will get the output same as the below response.

  {           “nodes”: {  “total”: 1,  “successful”: 1,  “failed”: 0              }  “cluster_name”: “elasticsearch”,  “nodes”: {         “DhlQVbbYS-SDo0HJC9pGjw”: {  “name”: “DESKTOP_MAJMT36”,  “transport_address”: “127.0.0.1:9300”,  “host”: “127.0.0.1”,  “ip”: “127.0.0.1”,  “version”: “7.8.0”,  “build_flovor”: “default”,  “build_type”: “zip”,  “build_hash”: “757314695644ea9a1dc2fecd26d1a43856725e65”,  “total_indexing_buffer”: 107374182,  .  .  .  .  .  .  .  .  “has_native_controller”: false        }  ],  “ingest”: {         “processors”: [         {  “type”: “append”         },         {  “type”: “bytes”         },         {  “type”: “urldecode”         },         {  “type”: “user_agent”         }     ]  }           }       }  }  

Following are some of the commands, which can execute to get more information about a cluster:

Cluster Health
Cluster State
Cluster Stats
Pending Cluster Tasks
Node Stats
Node hot_thread

Cluster Health

Using this API, we can check the health status of the cluster. The cluster health API helps to fetch the health of the cluster. It returns the cluster status as red, yellow, or green for stop, running, or ready, respectively.

Append the _cluster and health keyword in URL and get the status on the cluster health. Execute the following code and get the response:

Copy Code

Response

You will get the output like the below response.

  {  “cluster_name”: “elasticsearch”,  “status”: “yellow”,  “timed_out”: false,  “number_of_nodes”: 1,  “number_of_data_nodes”: 1,  “active_primary_nodes”: 4,  “active_shards”: 4,  “relocating_shards”: 0,  “initializing_shards”: 0,  “unassigned_shards”: 4,  “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  }  

Screenshot

Elasticsearch Cluster APIs

Cluster State

This API is used to get information about the cluster state. The state information contains the cluster name, state_uuid, version, master node, metadata, routing table, blocks, and much more.

Append the _cluster and state keyword in URL and get the information about the cluster state. Execute the following code and get the state information:

Copy Code

Response

You will get the output like the below response.

  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   “cluster_name”: “elasticsearch”,  “cluster_uuid”: “goGjM-AcQJyB8gb3-tC1KA”,  “version”: 230,  “state_uuid”: “f2CIE4YhT8WBW4Dg6NJrjA”,  “master_node”: “DhlQVbbYS-SDo0HJC9pGjw”,  “blocks”: { }  “nodes”: {        “DhlQVbbYS-SDo0HJC9pGjw”: {        “name”: “DESKTOP-MAJMT36”,        “ephemeral_id”: “NnB3ZSyPQJ-V-J2n4eENXA”,        “transport_address”: “127.0.0.1:9300”,        “attributes”: {  “ml.machine_memory”: “4194447360”,  “xpack.installed”: “true”,  “transform.node”: “true”,  “ml.max_open_jobs”: “20”           }      }            },  “metadata”: {  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  

Screenshot

Elasticsearch Cluster APIs

Cluster Stats

Stats stands for statistics. By using stats keyword, we can retrieve the statistics about cluster. It returns the statistics information about cluster along with shard number, memory usage, store size, roles, OS, number of nodes, and file system.

Append the _cluster and stats keyword in URL and get the information about cluster statistics. Execute the following code and get the statistics information of cluster:

Copy code

Response

You will get the output like the below response.

  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   “cluster_name”: “elasticsearch”,  “cluster_uuid”: “goGjM-AcQJyB8gb3-tC1KA”,  “timestamp”: 1595314120010,  “status”: “yellow”,  “indices”: {         “count”: 4,         “primaries”: 4,         “replication”: 0,         “index”: {         “shards”: {        “min”: 1,        “max”: 1,        “avg”: 1  },  “primaries”: {        “min”: 1,        “max”: 1,        “avg”: 1  },  “replication”: {        “min”: 1,        “max”: 1,        “avg”: 1  }      }  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  

Screenshot

Elasticsearch Cluster APIs

Pending Cluster Tasks

The pending cluster tasks API manages all the pending tasks in any cluster. It monitors tasks like create index, allocate or fail shard, and update mapping, etc. To monitor these tasks, append the _cluster and pending_tasks in URL and fetch all the remaining/pending tasks in the cluster. Copy the following code and execute the query:

Copy Code

Response

You will get the output like the below response if there is no pending task in the cluster.

Screenshot

Elasticsearch Cluster APIs

Cluster Reroute

The cluster reroute API is responsible for moving shards from one node to another. It can also allocate any unassigned shards and cancels the allocation of any shard. To successfully execute this query, we require to use the POST request method. Look at the following example below and execute it on your system:

Copy Code

Response

You will get the output like the below response.

  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .            “routing table”: {  “indices”: {      “new_student”: {           “shards”: {  “0”: [  {         “state”: “STARTED”,          “primary”: true,         “node”: “DhlQVbbYS-SDo0HJC9pGjw”,         “relocating_node”: null,         “shard”: 0,         “index”: “new_student”,          “allocation_id”: {  “id”: “Crrs3vwTT92n-NLyb_AJTA”          }     }     “state”: “UNASSIGNED”,     “primary”: false,     “node”: null,     “relocating_node”: null,     “shard”: 0,     “index”: “new_student”,     “recovery_source”: {  “type”: “PEER”       },      “unassigned_info”: {  “reason”: “CLUSTER_RECOVERED”,  “at”: “2020-07-21T05:53:05.282Z”,  “delayed”: false,  “allocated_status”: “no_attempt”       }  }         ]    }            },            “student1”: {       “shards”: {  “0”: [  {         “state”: “STARTED”,          “primary”: true,         “node”: “DhlQVbbYS-SDo0HJC9pGjw”,         “relocating_node”: null,  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   

Screenshot

Elasticsearch Cluster APIs

Cluster Update Settings

This API helps to update the setting of a cluster. Use the settings keyword to update cluster settings. Most of the cluster level APIs allow the user to specify the node to execute. There are two types of settings –

Persistent – It applied across the restart.
Transient – Do not survive a full cluster restart.

Execute the following code and get the response:

Copy Code

Response

By executing the above query, you will get the output like the below response.

Screenshot

Elasticsearch Cluster APIs

Persistent API

We can update settings to be persistent settings. Below is an example of persistent update:

Copy Code

  PUT http://localhost:9200/_cluster/settings/  {       “persistent”: {          “indices.recovery.max_bytes_per_sec”: “30mb”      }  }  

Response

By executing the above query, you will get the output like the below response.

  {             “acknowledged”: true,  “persistent”: {       “indices”: {            “recovery”: {     “max_bytes_per_sec”: “30mb”  }         }  },  “transient”: { }  }  

Screenshot

Elasticsearch Cluster APIs

Transient API

We can update settings to be transient settings. Below is an example of persistent update:

Copy Code

  PUT http://localhost:9200  {       “transient”: {          “indices.recovery.max_bytes_per_sec”: “50mb”      }  }  

Response

By executing the above query, you will get the output like the below response.

  {             “acknowledged”: true,  “persistent”: { },  “transient”: {     “indicies.recovery.max_bytes_per_sec”: “50mb”  }  }  

Screenshot

Elasticsearch Cluster APIs

Node Stats

The node stats API helps to retrieve the statistics about the node of the cluster. Node stats and cluster stats are almost same. We can retrieve the statistics for any number of nodes. To retrieve the statistics for a node, append _stats keyword along with _nodes keyword in URL.

Copy the following code and execute the query on your system:

Copy Code

Response

By executing the above query, you will get the output like the below response.

  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  “cluster_name”: “elasticsearch”,  “nodes”: {         “DhlQVbbYS-SDo0HJC9pGjw”: {  “timestamp”: 1595403071348,              “name”: “DESKTOP_MAJMT36”,  “transport_address”: “127.0.0.1:9300”,  “host”: “127.0.0.1”,  “ip”: “127.0.0.1:9300”,  “roles”: [      “data” ,      “ingest” ,      “master” ,      “ml” ,      “remote_cluster_client” ,      “transform”   ]  “attribute”: {       “ml.machine.memory”: “4194447360”       “xpack.installed”: “true”,       “transform.node”: “true”,       “ml.max_open_jobs”: “20”  },  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   

Screenshot

You will get the output same as in the below screenshot.

Elasticsearch Cluster APIs

Node hot_threads

This API is responsible for retrieving information about the current hot threads for each node in a cluster. To retrieve the information for hot thread on each node, append hot_threads keyword along with _nodes keyword in URL and get the respond in response body. GET method is used to send this http request.

Copy the following code and execute the query on your system. It will take a bit of time to execute completely.

Copy Code

Response

By executing the above query, you will get the output like the below response.

  {  “_nodes”: {     “total”: 0,     “successful”: 0,     “failed”: 0  },  “cluster_name”: “elasticsearch”,      “nodes”: { }  }   

Next TopicMigrations between Versions

Elasticsearch Cluster APIs

Elasticsearch Cluster APIs

Cluster Health

Cluster State

Cluster Stats

Pending Cluster Tasks

Cluster Reroute

Cluster Update Settings

Node Stats

Node hot_threads

Advanced Data Structure MCQ (Multiple Choice Questions)

Circular reference in Excel

You may also like