- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 7.10
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- HTTP
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Network settings
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot lifecycle management settings
- Transforms settings
- Transport
- Thread pools
- Watcher settings
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Set up X-Pack
- Configuring X-Pack Java Clients
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest node
- Search your data
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Geo-distance
- Geohash grid
- Geotile grid
- Global
- Histogram
- IP range
- Missing
- Nested
- Parent
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Bucket aggregations
- EQL
- SQL access
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Overview
- Concepts
- Automate rollover
- Manage Filebeat time-based indices
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Resolve lifecycle policy execution errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure a cluster
- Overview
- Configuring security
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Granting access to Stack Management features
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and index aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enabling audit logging
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watch for cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Nodes reload secure settings
- Nodes stats
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Cross-cluster replication APIs
- Data stream APIs
- Document APIs
- Enrich APIs
- Graph explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete component template
- Delete index template
- Delete index template (legacy)
- Flush
- Force merge
- Freeze index
- Get component template
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- Open index
- Put index template
- Put index template (legacy)
- Put component template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Simulate index
- Simulate template
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Resolve index
- List dangling indices
- Import dangling index
- Delete dangling index
- Index lifecycle management APIs
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Find file structure
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create trained models
- Update data frame analytics jobs
- Delete data frame analytics jobs
- Delete trained models
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get trained models
- Get trained models stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Search APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 7.10.2
- Elasticsearch version 7.10.1
- Elasticsearch version 7.10.0
- Elasticsearch version 7.9.3
- Elasticsearch version 7.9.2
- Elasticsearch version 7.9.1
- Elasticsearch version 7.9.0
- Elasticsearch version 7.8.1
- Elasticsearch version 7.8.0
- Elasticsearch version 7.7.1
- Elasticsearch version 7.7.0
- Elasticsearch version 7.6.2
- Elasticsearch version 7.6.1
- Elasticsearch version 7.6.0
- Elasticsearch version 7.5.2
- Elasticsearch version 7.5.1
- Elasticsearch version 7.5.0
- Elasticsearch version 7.4.2
- Elasticsearch version 7.4.1
- Elasticsearch version 7.4.0
- Elasticsearch version 7.3.2
- Elasticsearch version 7.3.1
- Elasticsearch version 7.3.0
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
- Dependencies and versions
cat nodes API
editcat nodes API
editReturns information about a cluster’s nodes.
Request
editGET /_cat/nodes
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor
ormanage
cluster privilege to use this API.
Query parameters
edit-
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. Iffalse
, return the shortened node ID. Defaults tofalse
. -
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) Maximum configured heap, such as
7
. -
ram.percent
,rp
,ramPercent
-
(Default) Used total memory percentage, such as
47
. -
file_desc.percent
,fdp
,fileDescriptorPercent
-
(Default) Used 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),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. See Node. -
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
,nodeId
-
ID of the node, such as
k0zy
. -
pid
,p
-
Process ID, such as
13061
. -
port
,po
-
Bound transport port, such as
9300
. -
http_address
,http
-
Bound http address, such as
127.0.0.1:9200
. -
version
,v
- Elasticsearch version, such as 7.10.2.
-
build
,b
-
Elasticsearch build hash, such as
5c03844
. -
jdk
,j
-
Java version, such as
1.8.0
. -
disk.total
,dt
,diskTotal
-
Total disk space, such as
458.3gb
. -
disk.used
,du
,diskUsed
-
Used disk space, such as
259.8gb
. -
disk.avail
,d
,disk
,diskAvail
-
Available disk space, such as
198.4gb
. -
disk.used_percent
,dup
,diskUsedPercent
-
Used disk space percentage, such as
47
. -
heap.current
,hc
,heapCurrent
-
Used heap, such as
311.2mb
. -
ram.current
,rc
,ramCurrent
-
Used total memory, such as
513.4mb
. -
ram.max
,rm
,ramMax
-
Total memory, such as
2.9gb
. -
file_desc.current
,fdc
,fileDescriptorCurrent
-
Used file descriptors, such as
123
. -
file_desc.max
,fdm
,fileDescriptorMax
-
Maximum number of file descriptors, such as
1024
. -
cpu
-
Recent system CPU usage as percent, such as
12
. -
load_1m
,l
-
Most recent load average, such as
0.22
. -
load_5m
,l
-
Load average for the last five minutes, such as
0.78
. -
load_15m
,l
-
Load average for the last fifteen minutes, such as
1.24
. -
uptime
,u
-
Node uptime, such as
17.3m
. -
completion.size
,cs
,completionSize
-
Size of completion, such as
0b
. -
fielddata.memory_size
,fm
,fielddataMemory
-
Used fielddata cache memory, such as
0b
. -
fielddata.evictions
,fe
,fielddataEvictions
-
Fielddata cache evictions, such as
0
. -
query_cache.memory_size
,qcm
,queryCacheMemory
-
Used query cache memory, such as
0b
. -
query_cache.evictions
,qce
,queryCacheEvictions
-
Query cache evictions, such as
0
. -
query_cache.hit_count
,qchc
,queryCacheHitCount
-
Query cache hit count, such as
0
. -
query_cache.miss_count
,qcmc
,queryCacheMissCount
-
Query cache miss count, such as
0
. -
request_cache.memory_size
,rcm
,requestCacheMemory
-
Used request cache memory, such as
0b
. -
request_cache.evictions
,rce
,requestCacheEvictions
-
Request cache evictions, such as
0
. -
request_cache.hit_count
,rchc
,requestCacheHitCount
-
Request cache hit count, such as
0
. -
request_cache.miss_count
,rcmc
,requestCacheMissCount
-
Request cache miss count, such as
0
. -
flush.total
,ft
,flushTotal
-
Number of flushes, such as
1
. -
flush.total_time
,ftt
,flushTotalTime
-
Time spent in flush, such as
1
. -
get.current
,gc
,getCurrent
-
Number of current get operations, such as
0
. -
get.time
,gti
,getTime
-
Time spent in get, such as
14ms
. -
get.total
,gto
,getTotal
-
Number of get operations, such as
2
. -
get.exists_time
,geti
,getExistsTime
-
Time spent in successful gets, such as
14ms
. -
get.exists_total
,geto
,getExistsTotal
-
Number of successful get operations, such as
2
. -
get.missing_time
,gmti
,getMissingTime
-
Time spent in failed gets, such as
0s
. -
get.missing_total
,gmto
,getMissingTotal
-
Number of failed get operations, such as
1
. -
indexing.delete_current
,idc
,indexingDeleteCurrent
-
Number of current deletion operations, such as
0
. -
indexing.delete_time
,idti
,indexingDeleteTime
-
Time spent in deletions, such as
2ms
. -
indexing.delete_total
,idto
,indexingDeleteTotal
-
Number of deletion operations, such as
2
. -
indexing.index_current
,iic
,indexingIndexCurrent
-
Number of current indexing operations, such as
0
. -
indexing.index_time
,iiti
,indexingIndexTime
-
Time spent in indexing, such as
134ms
. -
indexing.index_total
,iito
,indexingIndexTotal
-
Number of indexing operations, such as
1
. -
indexing.index_failed
,iif
,indexingIndexFailed
-
Number of failed indexing operations, such as
0
. -
merges.current
,mc
,mergesCurrent
-
Number of current merge operations, such as
0
. -
merges.current_docs
,mcd
,mergesCurrentDocs
-
Number of current merging documents, such as
0
. -
merges.current_size
,mcs
,mergesCurrentSize
-
Size of current merges, such as
0b
. -
merges.total
,mt
,mergesTotal
-
Number of completed merge operations, such as
0
. -
merges.total_docs
,mtd
,mergesTotalDocs
-
Number of merged documents, such as
0
. -
merges.total_size
,mts
,mergesTotalSize
-
Size of current merges, such as
0b
. -
merges.total_time
,mtt
,mergesTotalTime
-
Time spent merging documents, such as
0s
. -
refresh.total
,rto
,refreshTotal
-
Number of refreshes, such as
16
. -
refresh.time
,rti
,refreshTime
-
Time spent in refreshes, such as
91ms
. -
script.compilations
,scrcc
,scriptCompilations
-
Total script compilations, such as
17
. -
script.cache_evictions
,scrce
,scriptCacheEvictions
-
Total compiled scripts evicted from cache, such as
6
. -
search.fetch_current
,sfc
,searchFetchCurrent
-
Current fetch phase operations, such as
0
. -
search.fetch_time
,sfti
,searchFetchTime
-
Time spent in fetch phase, such as
37ms
. -
search.fetch_total
,sfto
,searchFetchTotal
-
Number of fetch operations, such as
7
. -
search.open_contexts
,so
,searchOpenContexts
-
Open search contexts, such as
0
. -
search.query_current
,sqc
,searchQueryCurrent
-
Current query phase operations, such as
0
. -
search.query_time
,sqti
,searchQueryTime
-
Time spent in query phase, such as
43ms
. -
search.query_total
,sqto
,searchQueryTotal
-
Number of query operations, such as
9
. -
search.scroll_current
,scc
,searchScrollCurrent
-
Open scroll contexts, such as
2
. -
search.scroll_time
,scti
,searchScrollTime
-
Time scroll contexts held open, such as
2m
. -
search.scroll_total
,scto
,searchScrollTotal
-
Completed scroll contexts, such as
1
. -
segments.count
,sc
,segmentsCount
-
Number of segments, such as
4
. -
segments.memory
,sm
,segmentsMemory
-
Memory used by segments, such as
1.4kb
. -
segments.index_writer_memory
,siwm
,segmentsIndexWriterMemory
-
Memory used by index writer, such as
18mb
. -
segments.version_map_memory
,svmm
,segmentsVersionMapMemory
-
Memory used by version map, such as
1.0kb
. -
segments.fixed_bitset_memory
,sfbm
,fixedBitsetMemory
-
Memory used by fixed bit sets for nested object field types and type filters for
types referred in
join
fields, such as1.0kb
. -
suggest.current
,suc
,suggestCurrent
-
Number of current suggest operations, such as
0
. -
suggest.time
,suti
,suggestTime
-
Time spent in suggest, such as
0
. -
suggest.total
,suto
,suggestTotal
-
Number of suggest operations, such as
0
.
-
-
help
-
(Optional, Boolean) If
true
, the response includes help information. Defaults tofalse
. -
local
-
(Optional, boolean)
[7.6.0]
Deprecated in 7.6.0. This parameter does not cause this API to act locally. It will be removed in version 8.0.
If
true
, the request computes the list of selected nodes from the local cluster state. Defaults tofalse
, which means the list of selected nodes is computed from the cluster state on the master node. In either case the coordinating node sends a request for further information to each selected node. -
master_timeout
-
(Optional, time units)
Period to wait for a connection to the master node. If no response is received
before the timeout expires, the request fails and returns an error. Defaults to
30s
. -
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 tofalse
.
Examples
editExample with default columns
editGET /_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 name 127.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
editThe following API request returns the id
, ip
, port
, v
(version), and m
(master) columns.
GET /_cat/nodes?v=true&h=id,ip,port,v,m
The API returns the following response:
id ip port v m veJR 127.0.0.1 59938 7.10.2 *
On this page