Get index information
Returns high-level information about indices in a cluster, including backing indices for data streams.
Use this request to get the following information for each index in a cluster:
- shard count
- document count
- deleted document count
- primary store size
- total store size of all shards, including shard replicas
These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count 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 an index endpoint.
Query parameters
-
bytes string
The unit used to display byte values.
Values are
b
,kb
,mb
,gb
,tb
, orpb
. -
expand_wildcards string | array[string]
The type of index that wildcard patterns can match.
-
health string
The health status used to limit returned indices. By default, the response includes indices of any health status.
Values are
green
,GREEN
,yellow
,YELLOW
,red
, orRED
. -
include_unloaded_segments boolean
If true, the response includes information from segments that are not loaded into memory.
-
pri boolean
If true, the response only includes information from primary shards.
-
time string
The unit used to display time values.
Values are
nanos
,micros
,ms
,s
,m
,h
, ord
.
Responses
-
200 application/json
Hide response attributes Show response attributes object
-
health string
current health status
-
status string
open/close status
-
index string
index name
-
uuid string
index uuid
-
pri string
number of primary shards
-
rep string
number of replica shards
-
creation.date string
index creation date (millisecond value)
-
creation.date.string string
index creation date (as string)
store.size string | null
store size of primaries & replicas
dataset.size string | null
total size of dataset (including the cache for partially mounted indices)
-
completion.size string
size of completion
-
pri.completion.size string
size of completion
-
fielddata.memory_size string
used fielddata cache
-
pri.fielddata.memory_size string
used fielddata cache
-
fielddata.evictions string
fielddata evictions
-
pri.fielddata.evictions string
fielddata evictions
-
query_cache.memory_size string
used query cache
-
pri.query_cache.memory_size string
used query cache
-
query_cache.evictions string
query cache evictions
-
pri.query_cache.evictions string
query cache evictions
-
request_cache.memory_size string
used request cache
-
used request cache
-
request_cache.evictions string
request cache evictions
-
pri.request_cache.evictions string
request cache evictions
-
request_cache.hit_count string
request cache hit count
-
pri.request_cache.hit_count string
request cache hit count
-
request_cache.miss_count string
request cache miss count
-
pri.request_cache.miss_count string
request cache miss count
-
flush.total string
number of flushes
-
pri.flush.total string
number of flushes
-
flush.total_time string
time spent in flush
-
pri.flush.total_time string
time spent in flush
-
get.current string
number of current get ops
-
pri.get.current string
number of current get ops
-
get.time string
time spent in get
-
pri.get.time string
time spent in get
-
get.total string
number of get ops
-
pri.get.total string
number of get ops
-
get.exists_time string
time spent in successful gets
-
pri.get.exists_time string
time spent in successful gets
-
get.exists_total string
number of successful gets
-
pri.get.exists_total string
number of successful gets
-
get.missing_time string
time spent in failed gets
-
pri.get.missing_time string
time spent in failed gets
-
get.missing_total string
number of failed gets
-
pri.get.missing_total string
number of failed gets
-
indexing.delete_current string
number of current deletions
-
pri.indexing.delete_current string
number of current deletions
-
indexing.delete_time string
time spent in deletions
-
pri.indexing.delete_time string
time spent in deletions
-
indexing.delete_total string
number of delete ops
-
pri.indexing.delete_total string
number of delete ops
-
indexing.index_current string
number of current indexing ops
-
pri.indexing.index_current string
number of current indexing ops
-
indexing.index_time string
time spent in indexing
-
pri.indexing.index_time string
time spent in indexing
-
indexing.index_total string
number of indexing ops
-
pri.indexing.index_total string
number of indexing ops
-
indexing.index_failed string
number of failed indexing ops
-
pri.indexing.index_failed string
number of failed indexing ops
-
merges.current string
number of current merges
-
pri.merges.current string
number of current merges
-
merges.current_docs string
number of current merging docs
-
pri.merges.current_docs string
number of current merging docs
-
merges.current_size string
size of current merges
-
pri.merges.current_size string
size of current merges
-
merges.total string
number of completed merge ops
-
pri.merges.total string
number of completed merge ops
-
merges.total_docs string
docs merged
-
pri.merges.total_docs string
docs merged
-
merges.total_size string
size merged
-
pri.merges.total_size string
size merged
-
merges.total_time string
time spent in merges
-
pri.merges.total_time string
time spent in merges
-
refresh.total string
total refreshes
-
pri.refresh.total string
total refreshes
-
refresh.time string
time spent in refreshes
-
pri.refresh.time string
time spent in refreshes
-
refresh.external_total string
total external refreshes
-
pri.refresh.external_total string
total external refreshes
-
refresh.external_time string
time spent in external refreshes
-
pri.refresh.external_time string
time spent in external refreshes
-
refresh.listeners string
number of pending refresh listeners
-
pri.refresh.listeners string
number of pending refresh listeners
-
search.fetch_current string
current fetch phase ops
-
pri.search.fetch_current string
current fetch phase ops
-
search.fetch_time string
time spent in fetch phase
-
pri.search.fetch_time string
time spent in fetch phase
-
search.fetch_total string
total fetch ops
-
pri.search.fetch_total string
total fetch ops
-
search.open_contexts string
open search contexts
-
pri.search.open_contexts string
open search contexts
-
search.query_current string
current query phase ops
-
pri.search.query_current string
current query phase ops
-
search.query_time string
time spent in query phase
-
pri.search.query_time string
time spent in query phase
-
search.query_total string
total query phase ops
-
pri.search.query_total string
total query phase ops
-
search.scroll_current string
open scroll contexts
-
pri.search.scroll_current string
open scroll contexts
-
search.scroll_time string
time scroll contexts held open
-
pri.search.scroll_time string
time scroll contexts held open
-
search.scroll_total string
completed scroll contexts
-
pri.search.scroll_total string
completed scroll contexts
-
segments.count string
number of segments
-
pri.segments.count string
number of segments
-
segments.memory string
memory used by segments
-
pri.segments.memory string
memory used by segments
-
segments.index_writer_memory string
memory used by index writer
-
memory used by index writer
-
segments.version_map_memory string
memory used by version map
-
memory used by version map
-
segments.fixed_bitset_memory string
memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields
-
memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields
-
warmer.current string
current warmer ops
-
pri.warmer.current string
current warmer ops
-
warmer.total string
total warmer ops
-
pri.warmer.total string
total warmer ops
-
warmer.total_time string
time spent in warmers
-
pri.warmer.total_time string
time spent in warmers
-
suggest.current string
number of current suggest ops
-
pri.suggest.current string
number of current suggest ops
-
suggest.time string
time spend in suggest
-
pri.suggest.time string
time spend in suggest
-
suggest.total string
number of suggest ops
-
pri.suggest.total string
number of suggest ops
-
memory.total string
total used memory
-
pri.memory.total string
total user memory
-
search.throttled string
indicates if the index is search throttled
-
bulk.total_operations string
number of bulk shard ops
-
pri.bulk.total_operations string
number of bulk shard ops
-
bulk.total_time string
time spend in shard bulk
-
pri.bulk.total_time string
time spend in shard bulk
-
bulk.total_size_in_bytes string
total size in bytes of shard bulk
-
pri.bulk.total_size_in_bytes string
total size in bytes of shard bulk
-
bulk.avg_time string
average time spend in shard bulk
-
pri.bulk.avg_time string
average time spend in shard bulk
-
bulk.avg_size_in_bytes string
average size in bytes of shard bulk
-
pri.bulk.avg_size_in_bytes string
average size in bytes of shard bulk
-
curl \
-X GET http://api.example.com/_cat/indices