Get cluster statistics
Added in 1.3.0
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).
Query parameters
-
include_remotes
boolean Include remote cluster data into the response
-
timeout
string Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s
_nodes.failedproperty. Defaults to no timeout.
GET
/_cluster/stats
curl \
--request GET 'http://api.example.com/_cluster/stats' \
--header "Authorization: $API_KEY"
Response examples (200)
{
"_nodes": {
"failures": [
{
"type": "string",
"reason": "string",
"stack_trace": "string",
"caused_by": {},
"root_cause": [
{}
],
"suppressed": [
{}
]
}
],
"total": 42.0,
"successful": 42.0,
"failed": 42.0
},
"cluster_name": "string",
"cluster_uuid": "string",
"indices": {
"analysis": {
"analyzer_types": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"built_in_analyzers": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"built_in_char_filters": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"built_in_filters": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"built_in_tokenizers": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"char_filter_types": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"filter_types": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"tokenizer_types": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
]
},
"completion": {
"size_in_bytes": 42.0,
"": 42.0,
"fields": {
"additionalProperty1": {
"size_in_bytes": 42.0
},
"additionalProperty2": {
"size_in_bytes": 42.0
}
}
},
"count": 42.0,
"docs": {
"count": 42.0,
"deleted": 42.0
},
"fielddata": {
"evictions": 42.0,
"": 42.0,
"memory_size_in_bytes": 42.0,
"fields": {
"additionalProperty1": {
"memory_size_in_bytes": 42.0
},
"additionalProperty2": {
"memory_size_in_bytes": 42.0
}
}
},
"query_cache": {
"cache_count": 42.0,
"cache_size": 42.0,
"evictions": 42.0,
"hit_count": 42.0,
"": 42.0,
"memory_size_in_bytes": 42.0,
"miss_count": 42.0,
"total_count": 42.0
},
"segments": {
"count": 42.0,
"": 42.0,
"doc_values_memory_in_bytes": 42.0,
"file_sizes": {
"additionalProperty1": {
"description": "string",
"size_in_bytes": 42.0,
"min_size_in_bytes": 42.0,
"max_size_in_bytes": 42.0,
"average_size_in_bytes": 42.0,
"count": 42.0
},
"additionalProperty2": {
"description": "string",
"size_in_bytes": 42.0,
"min_size_in_bytes": 42.0,
"max_size_in_bytes": 42.0,
"average_size_in_bytes": 42.0,
"count": 42.0
}
},
"fixed_bit_set_memory_in_bytes": 42.0,
"index_writer_max_memory_in_bytes": 42.0,
"index_writer_memory_in_bytes": 42.0,
"max_unsafe_auto_id_timestamp": 42.0,
"memory_in_bytes": 42.0,
"norms_memory_in_bytes": 42.0,
"points_memory_in_bytes": 42.0,
"stored_fields_memory_in_bytes": 42.0,
"terms_memory_in_bytes": 42.0,
"term_vectors_memory_in_bytes": 42.0,
"version_map_memory_in_bytes": 42.0
},
"shards": {
"index": {
"primaries": {
"avg": 42.0,
"max": 42.0,
"min": 42.0
},
"replication": {
"avg": 42.0,
"max": 42.0,
"min": 42.0
},
"shards": {
"avg": 42.0,
"max": 42.0,
"min": 42.0
}
},
"primaries": 42.0,
"replication": 42.0,
"total": 42.0
},
"store": {
"": 42.0,
"size_in_bytes": 42.0,
"reserved_in_bytes": 42.0,
"total_data_set_size_in_bytes": 42.0
},
"mappings": {
"field_types": [
{
"name": "string",
"count": 42.0,
"index_count": 42.0,
"indexed_vector_count": 42.0,
"indexed_vector_dim_max": 42.0,
"indexed_vector_dim_min": 42.0,
"script_count": 42.0
}
],
"runtime_field_types": [
{
"chars_max": 42.0,
"chars_total": 42.0,
"count": 42.0,
"doc_max": 42.0,
"doc_total": 42.0,
"index_count": 42.0,
"lang": [
"string"
],
"lines_max": 42.0,
"lines_total": 42.0,
"name": "string",
"scriptless_count": 42.0,
"shadowed_count": 42.0,
"source_max": 42.0,
"source_total": 42.0
}
],
"total_field_count": 42.0,
"total_deduplicated_field_count": 42.0,
"": 42.0,
"total_deduplicated_mapping_size_in_bytes": 42.0
},
"versions": [
{
"index_count": 42.0,
"primary_shard_count": 42.0,
"total_primary_bytes": 42.0,
"version": "string"
}
]
},
"nodes": {
"count": {
"coordinating_only": 42.0,
"data": 42.0,
"data_cold": 42.0,
"data_content": 42.0,
"data_frozen": 42.0,
"data_hot": 42.0,
"data_warm": 42.0,
"ingest": 42.0,
"master": 42.0,
"ml": 42.0,
"remote_cluster_client": 42.0,
"total": 42.0,
"transform": 42.0,
"voting_only": 42.0
},
"discovery_types": {
"additionalProperty1": 42.0,
"additionalProperty2": 42.0
},
"fs": {
"available_in_bytes": 42.0,
"free_in_bytes": 42.0,
"total_in_bytes": 42.0
},
"indexing_pressure": {
"memory": {
"current": {
"all_in_bytes": 42.0,
"combined_coordinating_and_primary_in_bytes": 42.0,
"coordinating_in_bytes": 42.0,
"coordinating_rejections": 42.0,
"primary_in_bytes": 42.0,
"primary_rejections": 42.0,
"replica_in_bytes": 42.0,
"replica_rejections": 42.0
},
"limit_in_bytes": 42.0,
"total": {
"all_in_bytes": 42.0,
"combined_coordinating_and_primary_in_bytes": 42.0,
"coordinating_in_bytes": 42.0,
"coordinating_rejections": 42.0,
"primary_in_bytes": 42.0,
"primary_rejections": 42.0,
"replica_in_bytes": 42.0,
"replica_rejections": 42.0
}
}
},
"ingest": {
"number_of_pipelines": 42.0,
"processor_stats": {
"additionalProperty1": {
"count": 42.0,
"current": 42.0,
"failed": 42.0,
"time": "string"
},
"additionalProperty2": {
"count": 42.0,
"current": 42.0,
"failed": 42.0,
"time": "string"
}
}
},
"jvm": {
"": 42.0,
"mem": {
"heap_max_in_bytes": 42.0,
"heap_used_in_bytes": 42.0
},
"threads": 42.0,
"versions": [
{
"bundled_jdk": true,
"count": 42.0,
"using_bundled_jdk": true,
"version": "string",
"vm_name": "string",
"vm_vendor": "string",
"vm_version": "string"
}
]
},
"network_types": {
"http_types": {
"additionalProperty1": 42.0,
"additionalProperty2": 42.0
},
"transport_types": {
"additionalProperty1": 42.0,
"additionalProperty2": 42.0
}
},
"os": {
"allocated_processors": 42.0,
"architectures": [
{
"arch": "string",
"count": 42.0
}
],
"available_processors": 42.0,
"mem": {
"adjusted_total_in_bytes": 42.0,
"free_in_bytes": 42.0,
"free_percent": 42.0,
"total_in_bytes": 42.0,
"used_in_bytes": 42.0,
"used_percent": 42.0
},
"names": [
{
"count": 42.0,
"name": "string"
}
],
"pretty_names": [
{
"count": 42.0,
"pretty_name": "string"
}
]
},
"packaging_types": [
{
"count": 42.0,
"flavor": "string",
"type": "string"
}
],
"plugins": [
{
"classname": "string",
"description": "string",
"elasticsearch_version": "string",
"extended_plugins": [
"string"
],
"has_native_controller": true,
"java_version": "string",
"name": "string",
"version": "string",
"licensed": true
}
],
"process": {
"cpu": {
"percent": 42.0
},
"open_file_descriptors": {
"avg": 42.0,
"max": 42.0,
"min": 42.0
}
},
"versions": [
"string"
]
},
"status": "green",
"timestamp": 42.0
}