Get node information

GET /_cat/nodes

Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Required authorization

Cluster privileges: monitor

Query Parameters

full_id boolean | string · default: false

If true, return the full node ID. If false, return the shortened node ID.

include_unloaded_segments boolean · default: false

If true, the response includes information from segments that are not loaded into memory.

h CatNodeColumns · default: ip,hp,rp,r,m,n,cpu,l

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

build (or b): The Elasticsearch build hash. For example: 5c03844.
completion.size (or cs, completionSize): The size of completion. For example: 0b.
cpu: The percentage of recent system CPU used.
disk.avail (or d, disk, diskAvail): The available disk space. For example: 198.4gb.
disk.total (or dt, diskTotal): The total disk space. For example: 458.3gb.
disk.used (or du, diskUsed): The used disk space. For example: 259.8gb.
disk.used_percent (or dup, diskUsedPercent): The percentage of disk space used.
fielddata.evictions (or fe, fielddataEvictions): The number of fielddata cache evictions.
fielddata.memory_size (or fm, fielddataMemory): The fielddata cache memory used. For example: 0b.
file_desc.current (or fdc, fileDescriptorCurrent): The number of file descriptors used.
file_desc.max (or fdm, fileDescriptorMax): The maximum number of file descriptors.
file_desc.percent (or fdp, fileDescriptorPercent): The percentage of file descriptors used.
flush.total (or ft, flushTotal): The number of flushes.
flush.total_time (or ftt, flushTotalTime): The amount of time spent in flush.
get.current (or gc, getCurrent): The number of current get operations.
get.exists_time (or geti, getExistsTime): The time spent in successful get operations. For example: 14ms.
get.exists_total (or geto, getExistsTotal): The number of successful get operations.
get.missing_time (or gmti, getMissingTime): The time spent in failed get operations. For example: 0s.
get.missing_total (or gmto, getMissingTotal): The number of failed get operations.
get.time (or gti, getTime): The amount of time spent in get operations. For example: 14ms.
get.total (or gto, getTotal): The number of get operations.
heap.current (or hc, heapCurrent): The used heap size. For example: 311.2mb.
heap.max (or hm, heapMax): The total heap size. For example: 4gb.
heap.percent (or hp, heapPercent): The used percentage of total allocated Elasticsearch JVM heap. This value reflects only the Elasticsearch process running within the operating system and is the most direct indicator of its JVM, heap, or memory resource performance.
http_address (or http): The bound HTTP address.
id (or nodeId): The identifier for the node.
indexing.delete_current (or idc, indexingDeleteCurrent): The number of current deletion operations.
indexing.delete_time (or idti, indexingDeleteTime): The time spent in deletion operations. For example: 2ms.
indexing.delete_total (or idto, indexingDeleteTotal): The number of deletion operations.
indexing.index_current (or iic, indexingIndexCurrent): The number of current indexing operations.
indexing.index_failed (or iif, indexingIndexFailed): The number of failed indexing operations.
indexing.index_failed_due_to_version_conflict (or iifvc, indexingIndexFailedDueToVersionConflict): The number of indexing operations that failed due to version conflict.
indexing.index_time (or iiti, indexingIndexTime): The time spent in indexing operations. For example: 134ms.
indexing.index_total (or iito, indexingIndexTotal): The number of indexing operations.
ip (or i): The IP address.
jdk (or j): The Java version. For example: 1.8.0.
load_1m (or l): The most recent load average. For example: 0.22.
load_5m (or l): The load average for the last five minutes. For example: 0.78.
load_15m (or l): The load average for the last fifteen minutes. For example: 1.24.
mappings.total_count (or mtc, mappingsTotalCount): The number of mappings, including runtime and object fields.
mappings.total_estimated_overhead_in_bytes (or mteo, mappingsTotalEstimatedOverheadInBytes): The estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.
master (or m): Indicates whether the node is the elected master node. Returned values include * (elected master) and - (not elected master).
merges.current (or mc, mergesCurrent): The number of current merge operations.
merges.current_docs (or mcd, mergesCurrentDocs): The number of current merging documents.
merges.current_size (or mcs, mergesCurrentSize): The size of current merges. For example: 0b.
merges.total (or mt, mergesTotal): The number of completed merge operations.
merges.total_docs (or mtd, mergesTotalDocs): The number of merged documents.
merges.total_size (or mts, mergesTotalSize): The total size of merges. For example: 0b.
merges.total_time (or mtt, mergesTotalTime): The time spent merging documents. For example: 0s.
name (or n): The node name.
node.role (or r, role, nodeRole): The roles of the node. Returned values include c (cold node), d (data node), f (frozen node), h (hot node), i (ingest node), l (machine learning node), m (master-eligible node), r (remote cluster client node), s (content node), t (transform node), v (voting-only node), w (warm node), and - (coordinating node only). For example, dim indicates a master-eligible data and ingest node.
pid (or p): The process identifier.
port (or po): The bound transport port number.
query_cache.memory_size (or qcm, queryCacheMemory): The used query cache memory. For example: 0b.
query_cache.evictions (or qce, queryCacheEvictions): The number of query cache evictions.
query_cache.hit_count (or qchc, queryCacheHitCount): The query cache hit count.
query_cache.miss_count (or qcmc, queryCacheMissCount): The query cache miss count.
ram.current (or rc, ramCurrent): The used total memory. For example: 513.4mb.
ram.max (or rm, ramMax): The total memory. For example: 2.9gb.
ram.percent (or rp, ramPercent): The used percentage of the total operating system memory. This reflects all processes running on the operating system instead of only Elasticsearch and is not guaranteed to correlate to its performance.
refresh.total (or rto, refreshTotal): The number of refresh operations.
refresh.time (or rti, refreshTime): The time spent in refresh operations. For example: 91ms.
request_cache.memory_size (or rcm, requestCacheMemory): The used request cache memory. For example: 0b.
request_cache.evictions (or rce, requestCacheEvictions): The number of request cache evictions.
request_cache.hit_count (or rchc, requestCacheHitCount): The request cache hit count.
request_cache.miss_count (or rcmc, requestCacheMissCount): The request cache miss count.
script.compilations (or scrcc, scriptCompilations): The number of total script compilations.
script.cache_evictions (or scrce, scriptCacheEvictions): The number of total compiled scripts evicted from cache.
search.fetch_current (or sfc, searchFetchCurrent): The number of current fetch phase operations.
search.fetch_time (or sfti, searchFetchTime): The time spent in fetch phase. For example: 37ms.
search.fetch_total (or sfto, searchFetchTotal): The number of fetch operations.
search.open_contexts (or so, searchOpenContexts): The number of open search contexts.
search.query_current (or sqc, searchQueryCurrent): The number of current query phase operations.
search.query_time (or sqti, searchQueryTime): The time spent in query phase. For example: 43ms.
search.query_total (or sqto, searchQueryTotal): The number of query operations.
search.scroll_current (or scc, searchScrollCurrent): The number of open scroll contexts.
search.scroll_time (or scti, searchScrollTime): The amount of time scroll contexts were held open. For example: 2m.
search.scroll_total (or scto, searchScrollTotal): The number of completed scroll contexts.
segments.count (or sc, segmentsCount): The number of segments.
segments.fixed_bitset_memory (or sfbm, fixedBitsetMemory): The memory used by fixed bit sets for nested object field types and type filters for types referred in join fields. For example: 1.0kb.
segments.index_writer_memory (or siwm, segmentsIndexWriterMemory): The memory used by the index writer. For example: 18mb.
segments.memory (or sm, segmentsMemory): The memory used by segments. For example: 1.4kb.
segments.version_map_memory (or svmm, segmentsVersionMapMemory): The memory used by the version map. For example: 1.0kb.
shard_stats.total_count (or sstc, shards, shardStatsTotalCount): The number of shards assigned.
suggest.current (or suc, suggestCurrent): The number of current suggest operations.
suggest.time (or suti, suggestTime): The time spent in suggest operations.
suggest.total (or suto, suggestTotal): The number of suggest operations.
uptime (or u): The amount of node uptime. For example: 17.3m.
version (or v): The Elasticsearch version. For example: 9.0.0.

s union Names

A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

One of: Name or Name[]

master_timeout string Duration · default: 30s

The period to wait for a connection to the master node.

Response

application/json

Examples

A successful response from GET /_cat/nodes?v=true&format=json. The ip, heap.percent, ram.percent, cpu, and load_* columns provide the IP addresses and performance information of each node. The node.role, master, and name columns provide information useful for monitoring an entire cluster, particularly large ones.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.nodes({
  v: "true",
  h: "id,ip,port,v,m",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.nodes(
    v=True,
    h="id,ip,port,v,m",
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/nodes?v=true&h=id,ip,port,v,m&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().nodes();

PHP Elasticsearch PHP Client

$resp = $client->cat()->nodes([
    "v" => "true",
    "h" => "id,ip,port,v,m",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.nodes(
  v: "true",
  h: "id,ip,port,v,m",
  format: "json"
)

Response

[
  {
    "ip": "127.0.0.1",
    "heap.percent": "65",
    "ram.percent": "99",
    "cpu": "42",
    "load_1m": "3.07",
    "load_5m": null,
    "load_15m": null,
    "node.role": "cdfhilmrstw",
    "master": "*",
    "name": "mJw06l1"
  }
]

Required authorization

Query Parameters { full_id , include_unloaded_segments , h , s , master_timeout , }

Response

Query Parameters