Returns 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.
Query parameters
-
bytes string
The unit used to display byte values.
Values are
b
,kb
,mb
,gb
,tb
, orpb
. -
full_id boolean | string
If
true
, return the full node ID. Iffalse
, return the shortened node ID. -
include_unloaded_segments boolean
If true, the response includes information from segments that are not loaded into memory.
GET /_cat/nodes
curl \
-X GET http://api.example.com/_cat/nodes
Response examples (200)
[
{
"id": "string",
"pid": "string",
"ip": "string",
"port": "string",
"http_address": "string",
"version": "string",
"flavor": "string",
"type": "string",
"build": "string",
"jdk": "string",
"": "string",
"heap.current": "string",
"heap.max": "string",
"ram.current": "string",
"ram.max": "string",
"file_desc.current": "string",
"file_desc.max": "string",
"cpu": "string",
"load_1m": "string",
"load_5m": "string",
"load_15m": "string",
"uptime": "string",
"node.role": "string",
"master": "string",
"name": "string",
"completion.size": "string",
"fielddata.memory_size": "string",
"fielddata.evictions": "string",
"query_cache.memory_size": "string",
"query_cache.evictions": "string",
"query_cache.hit_count": "string",
"query_cache.miss_count": "string",
"request_cache.memory_size": "string",
"request_cache.evictions": "string",
"request_cache.hit_count": "string",
"request_cache.miss_count": "string",
"flush.total": "string",
"flush.total_time": "string",
"get.current": "string",
"get.time": "string",
"get.total": "string",
"get.exists_time": "string",
"get.exists_total": "string",
"get.missing_time": "string",
"get.missing_total": "string",
"indexing.delete_current": "string",
"indexing.delete_time": "string",
"indexing.delete_total": "string",
"indexing.index_current": "string",
"indexing.index_time": "string",
"indexing.index_total": "string",
"indexing.index_failed": "string",
"merges.current": "string",
"merges.current_docs": "string",
"merges.current_size": "string",
"merges.total": "string",
"merges.total_docs": "string",
"merges.total_size": "string",
"merges.total_time": "string",
"refresh.total": "string",
"refresh.time": "string",
"refresh.external_total": "string",
"refresh.external_time": "string",
"refresh.listeners": "string",
"script.compilations": "string",
"script.cache_evictions": "string",
"script.compilation_limit_triggered": "string",
"search.fetch_current": "string",
"search.fetch_time": "string",
"search.fetch_total": "string",
"search.open_contexts": "string",
"search.query_current": "string",
"search.query_time": "string",
"search.query_total": "string",
"search.scroll_current": "string",
"search.scroll_time": "string",
"search.scroll_total": "string",
"segments.count": "string",
"segments.memory": "string",
"segments.index_writer_memory": "string",
"segments.version_map_memory": "string",
"segments.fixed_bitset_memory": "string",
"suggest.current": "string",
"suggest.time": "string",
"suggest.total": "string",
"bulk.total_operations": "string",
"bulk.total_time": "string",
"bulk.total_size_in_bytes": "string",
"bulk.avg_time": "string",
"bulk.avg_size_in_bytes": "string"
}
]