IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Guide [6.5] » cat APIs » cat indices
« cat health
cat master »
cat indices
The indices command provides a cross-section of each index. This information spans nodes. For example:
GET /​_cat​/​indices​/​twi*​?​v​&​s​=​index
Copy as curlView in Console

 
Might respond with:
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size yellow open twitter u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb green open twitter2 nYFWZEO7TUiOjLQXBaYJpA 5 0 0 0 260b 260b
We can tell quickly how many shards make up an index, the number of docs, deleted docs, primary store size, and total store size (all shards including replicas). All these exposed metrics come directly from Lucene APIs.
Notes:
  1. As the number of documents and deleted documents shown in this are at the lucene level, it includes all the hidden documents (e.g. from nested documents) as well.
  2. To get actual count of documents at the Elasticsearch level, the recommended way is to use either the cat count or the Count API
Primaries
The index stats by default will show them for all of an index’s shards, including replicas. A pri flag can be supplied to enable the view of relevant stats in the context of only the primaries.
Examples
Which indices are yellow?
GET /​_cat​/​indices​?​v​&​health​=​yellow
Copy as curlView in Console

 
Which looks like:
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size yellow open twitter u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb
Which index has the largest number of documents?
GET /​_cat​/​indices​?​v​&​s​=​docs.count:desc
Copy as curlView in Console

 
Which looks like:
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size yellow open twitter u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb green open twitter2 nYFWZEO7TUiOjLQXBaYJpA 5 0 0 0 260b 260b
How many merge operations have the shards for the twitter completed?
GET /​_cat​/​indices​/​twitter​?​pri​&​v​&​h​=​health,index,pri,rep,docs.count,mt
Copy as curlView in Console

 
Might look like:
health index pri rep docs.count mt pri.mt yellow twitter 1 1 1200 16 16
How much memory is used per index?
GET /​_cat​/​indices​?​v​&​h​=​i,tm​&​s​=​tm:desc
Copy as curlView in Console

 
Might look like:
i tm twitter 8.1gb twitter2 30.5kb
« cat health
cat master »
On this page
Primaries
Examples
We're hiring

Work for a global, distributed team where finding someone like you is just a Zoom meeting away. Flexible work with impact? Development opportunities from the start?
Discover your career
Recommended for you
Elastic 7.15: Create powerful, personalized search experiences in seconds
Distributed Elastic Architectures
Twilio
Elasticsearch: Getting Started
Elastic 7.14.0 introduces the industry’s first free and open Limitless XDR
Elasticsearch Guide:
Getting Started
Set up Elasticsearch
Upgrade Elasticsearch
API Conventions
Document APIs
Search APIs
Aggregations
Indices APIs
cat APIs
cat aliases
cat allocation
cat count
cat fielddata
cat health
cat indices
cat master
cat nodeattrs
cat nodes
cat pending tasks
cat plugins
cat recovery
cat repositories
cat thread pool
cat shards
cat segments
cat snapshots
cat templates
Cluster APIs
Query DSL
Mapping
Analysis
Modules
Index Modules
Ingest Node
SQL Access
Monitor a cluster
Rolling up historical data
Set up a cluster for high availability
Secure a cluster
Alerting on Cluster and Index Events
Command line tools
How To
Testing
Glossary of terms
X-Pack APIs
Release Highlights
Breaking changes
Release Notes
Subscribe to our newsletter

PRODUCTS & SOLUTIONS
Enterprise Search
Observability
Security
Elastic Stack
Elasticsearch
Kibana
Logstash
Beats
Elastic Agent
Subscriptions
Pricing
COMPANY
Careers
WE'RE HIRING
Board of Directors
Contact
RESOURCES
ElasticON Global
Documentation
What is the ELK Stack?
What is Elasticsearch?
Migrating from Splunk
Compare AWS Elasticsearch
US Public Sector
Follow Us
TrademarksTerms of UsePrivacyBrandSitemap
Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries.
Apache, Apache Lucene, Apache Hadoop, Hadoop, HDFS and the yellow elephant logo are trademarks of the Apache Software Foundation in the United States and/or other countries.
© 2021. Elasticsearch B.V. All Rights Reserved