Get index information Generally available
All methods and paths for this operation:
Get 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.
Required authorization
- Index privileges:
monitor - Cluster privileges:
monitor
Path parameters
-
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (
*). To target all data streams and indices, omit this parameter or use*or_all.
Query parameters
-
The unit used to display byte values.
Values are
b,kb,mb,gb,tb, orpb. -
The type of index that wildcard patterns can match.
Supported values include:
all: Match any data stream or index, including hidden ones.open: Match open, non-hidden indices. Also matches any non-hidden data stream.closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.hidden: Match hidden data streams and hidden indices. Must be combined withopen,closed, orboth.none: Wildcard expressions are not accepted.
Values are
all,open,closed,hidden, ornone. -
The health status used to limit returned indices. By default, the response includes indices of any health status.
Supported values include:
green(orGREEN): All shards are assigned.yellow(orYELLOW): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.red(orRED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.
Values are
green,GREEN,yellow,YELLOW,red, orRED. -
If true, the response includes information from segments that are not loaded into memory.
-
If true, the response only includes information from primary shards.
-
The unit used to display time values.
Values are
nanos,micros,ms,s,m,h, ord. -
Period to wait for a connection to the master node.
Values are
-1or0. -
List of columns to appear in the response. Supports simple wildcards.
-
List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting
:ascor:descas a suffix to the column name.
GET /_cat/indices/my-index-*?v=true&s=index&format=json resp = client.cat.indices( index="my-index-*", v=True, s="index", format="json", )const response = await client.cat.indices({ index: "my-index-*", v: "true", s: "index", format: "json", });response = client.cat.indices( index: "my-index-*", v: "true", s: "index", format: "json" )$resp = $client->cat()->indices([ "index" => "my-index-*", "v" => "true", "s" => "index", "format" => "json", ]);curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/indices/my-index-*?v=true&s=index&format=json"client.cat().indices(); [ { "health": "yellow", "status": "open", "index": "my-index-000001", "uuid": "u8FNjxh8Rfy_awN11oDKYQ", "pri": "1", "rep": "1", "docs.count": "1200", "docs.deleted": "0", "store.size": "88.1kb", "pri.store.size": "88.1kb", "dataset.size": "88.1kb" }, { "health": "green", "status": "open", "index": "my-index-000002", "uuid": "nYFWZEO7TUiOjLQXBaYJpA ", "pri": "1", "rep": "0", "docs.count": "0", "docs.deleted": "0", "store.size": "260b", "pri.store.size": "260b", "dataset.size": "260b" } ]