Get cluster statistics

GET /_cluster/stats/nodes/{node_id}
GET /_cluster/stats

Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

Required authorization

Cluster privileges: monitor

Path Parameters

node_id union NodeId | [] NodeId optional

Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

Leave it out to use /_cluster/stats.

Query Parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size*

JavaScript Elasticsearch JavaScript Client

const response = await client.cluster.stats({
  human: "true",
  filter_path: "indices.mappings.total_deduplicated_mapping_size*",
});

Python Elasticsearch Python Client

resp = client.cluster.stats(
    human=True,
    filter_path="indices.mappings.total_deduplicated_mapping_size*",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size*" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cluster().stats(s -> s);

C# Elasticsearch .NET Client

var response = await client.Cluster.StatsAsync();

PHP Elasticsearch PHP Client

$resp = $client->cluster()->stats([
    "human" => "true",
    "filter_path" => "indices.mappings.total_deduplicated_mapping_size*",
]);

Ruby Elasticsearch Ruby Client

response = client.cluster.stats(
  human: "true",
  filter_path: "indices.mappings.total_deduplicated_mapping_size*"
)

Response

No example

Required authorization

Path Parameters

Query Parameters { include_remotes , timeout , }

Response

Query Parameters