我的书签
添加书签
移除书签cat nodes API
cat nodes API
New API reference
For the most up-to-date API details, refer to Compact and aligned text (CAT) APIs..
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.
Returns information about a cluster’s nodes.
Request
GET /_cat/nodes
Prerequisites
- If the Elasticsearch security features are enabled, you must have the
monitorormanagecluster privilege to use this API.
Query parameters
bytes
(Optional, byte size units) Unit used to display byte values.
format
(Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
full_id
(Optional, Boolean) If true, return the full node ID. If false, return the shortened node ID. Defaults to false.
h
(Optional, string) Comma-separated list of column names to display.
If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns.
Valid columns are:
ip,i(Default) IP address, such as
127.0.1.1.heap.percent,hp,heapPercent(Default) Used percentage of total allocated Elasticsearch JVM heap, such as
7. This reflects only the Elasticsearch process running within the operating system and is the most direct indicator of its JVM/heap/memory resource performance.heap.max,hm,heapMaxTotal heap, such as
4gb.ram.percent,rp,ramPercent(Default) Used percentage of total operating system’s memory, such as
47. This reflects all processes running on operating system instead of only Elasticsearch and is not guaranteed to correlate to its performance.file_desc.percent,fdp,fileDescriptorPercentUsed file descriptors percentage, such as
1.node.role,r,role,nodeRole(Default) 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,
dimindicates a master-eligible data and ingest node. See Node settings.master,m(Default) Indicates whether the node is the elected master node. Returned values include
*(elected master) and-(not elected master).name,n(Default) Node name, such as
I8hydUG.id,nodeIdID of the node, such as
k0zy.pid,pProcess ID, such as
13061.port,poBound transport port, such as
9300.http_address,httpBound http address, such as
127.0.0.1:9200.version,vElasticsearch version, such as 8.17.0.
build,bElasticsearch build hash, such as
5c03844.jdk,jJava version, such as
1.8.0.disk.total,dt,diskTotalTotal disk space, such as
458.3gb.disk.used,du,diskUsedUsed disk space, such as
259.8gb.disk.avail,d,disk,diskAvailAvailable disk space, such as
198.4gb.disk.used_percent,dup,diskUsedPercentUsed disk space percentage, such as
47.heap.current,hc,heapCurrentUsed heap, such as
311.2mb.ram.current,rc,ramCurrentUsed total memory, such as
513.4mb.ram.max,rm,ramMaxTotal memory, such as
2.9gb.file_desc.current,fdc,fileDescriptorCurrentUsed file descriptors, such as
123.file_desc.max,fdm,fileDescriptorMaxMaximum number of file descriptors, such as
1024.cpu(Default) Recent system CPU usage as percent, such as
12.load_1m,l(Default) Most recent load average, such as
0.22.load_5m,l(Default) Load average for the last five minutes, such as
0.78.load_15m,l(Default) Load average for the last fifteen minutes, such as
1.24.uptime,uNode uptime, such as
17.3m.completion.size,cs,completionSizeSize of completion, such as
0b.fielddata.memory_size,fm,fielddataMemoryUsed fielddata cache memory, such as
0b.fielddata.evictions,fe,fielddataEvictionsFielddata cache evictions, such as
0.query_cache.memory_size,qcm,queryCacheMemoryUsed query cache memory, such as
0b.query_cache.evictions,qce,queryCacheEvictionsQuery cache evictions, such as
0.query_cache.hit_count,qchc,queryCacheHitCountQuery cache hit count, such as
0.query_cache.miss_count,qcmc,queryCacheMissCountQuery cache miss count, such as
0.request_cache.memory_size,rcm,requestCacheMemoryUsed request cache memory, such as
0b.request_cache.evictions,rce,requestCacheEvictionsRequest cache evictions, such as
0.request_cache.hit_count,rchc,requestCacheHitCountRequest cache hit count, such as
0.request_cache.miss_count,rcmc,requestCacheMissCountRequest cache miss count, such as
0.flush.total,ft,flushTotalNumber of flushes, such as
1.flush.total_time,ftt,flushTotalTimeTime spent in flush, such as
1.get.current,gc,getCurrentNumber of current get operations, such as
0.get.time,gti,getTimeTime spent in get, such as
14ms.get.total,gto,getTotalNumber of get operations, such as
2.get.exists_time,geti,getExistsTimeTime spent in successful gets, such as
14ms.get.exists_total,geto,getExistsTotalNumber of successful get operations, such as
2.get.missing_time,gmti,getMissingTimeTime spent in failed gets, such as
0s.get.missing_total,gmto,getMissingTotalNumber of failed get operations, such as
1.indexing.delete_current,idc,indexingDeleteCurrentNumber of current deletion operations, such as
0.indexing.delete_time,idti,indexingDeleteTimeTime spent in deletions, such as
2ms.indexing.delete_total,idto,indexingDeleteTotalNumber of deletion operations, such as
2.indexing.index_current,iic,indexingIndexCurrentNumber of current indexing operations, such as
0.indexing.index_time,iiti,indexingIndexTimeTime spent in indexing, such as
134ms.indexing.index_total,iito,indexingIndexTotalNumber of indexing operations, such as
1.indexing.index_failed,iif,indexingIndexFailedNumber of failed indexing operations, such as
0.merges.current,mc,mergesCurrentNumber of current merge operations, such as
0.merges.current_docs,mcd,mergesCurrentDocsNumber of current merging documents, such as
0.merges.current_size,mcs,mergesCurrentSizeSize of current merges, such as
0b.merges.total,mt,mergesTotalNumber of completed merge operations, such as
0.merges.total_docs,mtd,mergesTotalDocsNumber of merged documents, such as
0.merges.total_size,mts,mergesTotalSizeSize of current merges, such as
0b.merges.total_time,mtt,mergesTotalTimeTime spent merging documents, such as
0s.refresh.total,rto,refreshTotalNumber of refreshes, such as
16.refresh.time,rti,refreshTimeTime spent in refreshes, such as
91ms.script.compilations,scrcc,scriptCompilationsTotal script compilations, such as
17.script.cache_evictions,scrce,scriptCacheEvictionsTotal compiled scripts evicted from cache, such as
6.search.fetch_current,sfc,searchFetchCurrentCurrent fetch phase operations, such as
0.search.fetch_time,sfti,searchFetchTimeTime spent in fetch phase, such as
37ms.search.fetch_total,sfto,searchFetchTotalNumber of fetch operations, such as
7.search.open_contexts,so,searchOpenContextsOpen search contexts, such as
0.search.query_current,sqc,searchQueryCurrentCurrent query phase operations, such as
0.search.query_time,sqti,searchQueryTimeTime spent in query phase, such as
43ms.search.query_total,sqto,searchQueryTotalNumber of query operations, such as
9.search.scroll_current,scc,searchScrollCurrentOpen scroll contexts, such as
2.search.scroll_time,scti,searchScrollTimeTime scroll contexts held open, such as
2m.search.scroll_total,scto,searchScrollTotalCompleted scroll contexts, such as
1.segments.count,sc,segmentsCountNumber of segments, such as
4.segments.memory,sm,segmentsMemoryMemory used by segments, such as
1.4kb.segments.index_writer_memory,siwm,segmentsIndexWriterMemoryMemory used by index writer, such as
18mb.segments.version_map_memory,svmm,segmentsVersionMapMemoryMemory used by version map, such as
1.0kb.segments.fixed_bitset_memory,sfbm,fixedBitsetMemoryMemory used by fixed bit sets for nested object field types and type filters for types referred in join fields, such as
1.0kb.suggest.current,suc,suggestCurrentNumber of current suggest operations, such as
0.suggest.time,suti,suggestTimeTime spent in suggest, such as
0.suggest.total,suto,suggestTotalNumber of suggest operations, such as
0.shard_stats.total_count,sstc,shards,shardStatsTotalCountNumber of shards assigned.
mappings.total_count,mtc,mappingsTotalCountNumber of mappings, including runtime and object fields.
mappings.total_estimated_overhead_in_bytes,mteo,mappingsTotalEstimatedOverheadInBytesEstimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.
help
(Optional, Boolean) If true, the response includes help information. Defaults to false.
master_timeout
(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
s
(Optional, string) Comma-separated list of column names or column aliases used to sort the response.
time
(Optional, time units) Unit used to display time values.
v
(Optional, Boolean) If true, the response includes column headings. Defaults to false.
include_unloaded_segments
(Optional, Boolean) If true, the response includes information from segments that are not loaded into memory. Defaults to false.
Examples
Example with default columns
resp = client.cat.nodes(v=True,)print(resp)
response = client.cat.nodes(v: true)puts response
const response = await client.cat.nodes({v: "true",});console.log(response);
GET /_cat/nodes?v=true
The API returns the following response:
ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name127.0.0.1 65 99 42 3.07 dim * mJw06l1
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.
Example with explicit columns
The following API request returns the id, ip, port, v (version), and m (master) columns.
resp = client.cat.nodes(v=True,h="id,ip,port,v,m",)print(resp)
response = client.cat.nodes(v: true,h: 'id,ip,port,v,m')puts response
const response = await client.cat.nodes({v: "true",h: "id,ip,port,v,m",});console.log(response);
GET /_cat/nodes?v=true&h=id,ip,port,v,m
The API returns the following response:
id ip port v mveJR 127.0.0.1 59938 8.17.0 *
