Get cluster statistics

GET /_cluster/stats

Copy endpoint

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

Parameters

query Query Parameters

Name	Type
`include_remotes` Include remote cluster data into the response	boolean
`timeout` 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.failed` property. Defaults to no timeout.	type TypesDuration = string \| "-1" \| "0"

Responses

200 application/json

type ClusterStatsStatsResponseBase = interface NodesTypesNodesResponseBase {
_nodes?:

TypesNodeStatistics

Contains statistics about the number of nodes selected by the request.

interface TypesNodeStatistics {
failures?: TypesErrorCause[];
total: number;
successful: number;
failed: number;
}

;
} & {
cluster_name:

TypesName

type TypesName = string

;
cluster_uuid:

TypesUuid

type TypesUuid = string

;
indices:

ClusterStatsClusterIndices

interface ClusterStatsClusterIndices {
analysis?: ClusterStatsCharFilterTypes;
completion: TypesCompletionStats;
count: number;
docs: TypesDocStats;
fielddata: TypesFielddataStats;
query_cache: TypesQueryCacheStats;
search: ClusterStatsSearchUsageStats;
segments: TypesSegmentsStats;
shards: ClusterStatsClusterIndicesShards;
store: TypesStoreStats;
mappings?: ClusterStatsFieldTypesMappings;
versions?: ClusterStatsIndicesVersions[];
dense_vector: ClusterStatsDenseVectorStats;
sparse_vector: ClusterStatsSparseVectorStats;
}

;
nodes:

ClusterStatsClusterNodes

interface ClusterStatsClusterNodes {
count: ClusterStatsClusterNodeCount;
discovery_types: { };
fs: ClusterStatsClusterFileSystem;
indexing_pressure: ClusterStatsIndexingPressure;
ingest: ClusterStatsClusterIngest;
jvm: ClusterStatsClusterJvm;
network_types: ClusterStatsClusterNetworkTypes;
os: ClusterStatsClusterOperatingSystem;
packaging_types: ClusterStatsNodePackagingType[];
plugins: TypesPluginStats[];
process: ClusterStatsClusterProcess;
versions: TypesVersionString[];
}

;
repositories: { };
snapshots:

ClusterStatsClusterSnapshotStats

interface ClusterStatsClusterSnapshotStats {
current_counts: ClusterStatsSnapshotCurrentCounts;
repositories: { };
}

;
status?:

TypesHealthStatus

;
timestamp: number;
ccs:

ClusterStatsCCSStats

interface ClusterStatsCCSStats {
clusters?: { };
_search: ClusterStatsCCSUsageStats;
_esql?: ClusterStatsCCSUsageStats;
}

;
}