Get a compact list of nodes

  • GET /_cat/nodes
Auth

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 · 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 union oneOf · 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.
  • available_processors (or ap): The number of available processors (logical CPU cores available to the JVM).
  • 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.
One of: string[] or string
s union string | string[]

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.

master_timeout string · default: 30s

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

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb
time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json
<array> object[]
id string

The unique node identifier.

pid string

The process identifier.

ip string

The IP address.

port string

The bound transport port.

http_address string

The bound HTTP address.

version string

The Elasticsearch version.

flavor string

The Elasticsearch distribution flavor.

type string

The Elasticsearch distribution type.

build string

The Elasticsearch build hash.

jdk string

The Java version.

disk.total number | string

The total disk space.

disk.used number | string

The used disk space.

disk.avail number | string

The available disk space.

disk.used_percent number | string

The used disk space percentage.

heap.current string

The used heap.

heap.percent number | string

The used heap ratio.

heap.max string

The maximum configured heap.

ram.current string

The used machine memory.

ram.percent number | string

The used machine memory ratio.

ram.max string

The total machine memory.

file_desc.current string

The used file descriptors.

file_desc.percent number | string

The used file descriptor ratio.

file_desc.max string

The maximum number of file descriptors.

cpu string

The recent system CPU usage as a percentage.

load_1m string

The load average for the most recent minute.

load_5m string

The load average for the last five minutes.

load_15m string

The load average for the last fifteen minutes.

available_processors string

The number of available processors (logical CPU cores available to the JVM).

uptime string

The node uptime.

node.role string

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).

master string

Indicates whether the node is the elected master node. Returned values include *(elected master) and -(not elected master).

name string

The node name.

completion.size string

The size of completion.

fielddata.memory_size string

The used fielddata cache.

fielddata.evictions string

The fielddata evictions.

query_cache.memory_size string

The used query cache.

query_cache.evictions string

The query cache evictions.

query_cache.hit_count string

The query cache hit counts.

query_cache.miss_count string

The query cache miss counts.

request_cache.memory_size string

The used request cache.

request_cache.evictions string

The request cache evictions.

request_cache.hit_count string

The request cache hit counts.

request_cache.miss_count string

The request cache miss counts.

flush.total string

The number of flushes.

flush.total_time string

The time spent in flush.

get.current string

The number of current get ops.

get.time string

The time spent in get.

get.total string

The number of get ops.

get.exists_time string

The time spent in successful gets.

get.exists_total string

The number of successful get operations.

get.missing_time string

The time spent in failed gets.

get.missing_total string

The number of failed gets.

indexing.delete_current string

The number of current deletions.

indexing.delete_time string

The time spent in deletions.

indexing.delete_total string

The number of delete operations.

indexing.index_current string

The number of current indexing operations.

indexing.index_time string

The time spent in indexing.

indexing.index_total string

The number of indexing operations.

indexing.index_failed string

The number of failed indexing operations.

merges.current string

The number of current merges.

merges.current_docs string

The number of current merging docs.

merges.current_size string

The size of current merges.

merges.total string

The number of completed merge operations.

merges.total_docs string

The docs merged.

merges.total_size string

The size merged.

merges.total_time string

The time spent in merges.

refresh.total string

The total refreshes.

refresh.time string

The time spent in refreshes.

refresh.external_total string

The total external refreshes.

refresh.external_time string

The time spent in external refreshes.

refresh.listeners string

The number of pending refresh listeners.

script.compilations string

The total script compilations.

script.cache_evictions string

The total compiled scripts evicted from the cache.

script.compilation_limit_triggered string

The script cache compilation limit triggered.

search.fetch_current string

The current fetch phase operations.

search.fetch_time string

The time spent in fetch phase.

search.fetch_total string

The total fetch operations.

search.open_contexts string

The open search contexts.

search.query_current string

The current query phase operations.

search.query_time string

The time spent in query phase.

search.query_total string

The total query phase operations.

search.scroll_current string

The open scroll contexts.

search.scroll_time string

The time scroll contexts held open.

search.scroll_total string

The completed scroll contexts.

segments.count string

The number of segments.

segments.memory string

The memory used by segments.

segments.index_writer_memory string

The memory used by the index writer.

segments.version_map_memory string

The memory used by the version map.

segments.fixed_bitset_memory string

The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.

suggest.current string

The number of current suggest operations.

suggest.time string

The time spend in suggest.

suggest.total string

The number of suggest operations.

bulk.total_operations string

The number of bulk shard operations.

bulk.total_time string

The time spend in shard bulk.

bulk.total_size_in_bytes string

The total size in bytes of shard bulk.

bulk.avg_time string

The average time spend in shard bulk.

bulk.avg_size_in_bytes string

The average size in bytes of shard bulk.