Skip to content

Latest commit

 

History

History
88 lines (69 loc) · 3.01 KB

cat-indices.md

File metadata and controls

88 lines (69 loc) · 3.01 KB
layout title parent nav_order has_children redirect_from
default
CAT indices
CAT API
25
false
/opensearch/rest-api/cat/cat-indices/

CAT indices

Introduced 1.0 {: .label .label-purple }

The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.

Endpoints

GET /_cat/indices
GET /_cat/indices/{index}

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Parameter Data type Description Default
bytes String The units used to display byte values.
cluster_manager_timeout String The amount of time allowed to establish a connection to the cluster manager node.
expand_wildcards List or String The type of index that wildcard patterns can match. Supported values are all, open, closed, hidden, and none.
format String A short version of the Accept header, such as json or yaml.
h List A comma-separated list of column names to display.
health String Limits indexes based on their health status. Supported values are green, yellow, and red.
help Boolean Returns help information. false
include_unloaded_segments Boolean Whether to include information from segments not loaded into memory. false
local Boolean Returns local information but does not retrieve the state from the cluster manager node. false
pri Boolean When true, returns information only from the primary shards. false
s List A comma-separated list of column names or column aliases to sort by.
time String Specifies the time units.
v Boolean Enables verbose mode, which displays column headers. false

Example requests

GET _cat/indices?v

{% include copy-curl.html %}

To limit the information to a specific index, add the index name after your query.

GET _cat/indices/<index>?v

{% include copy-curl.html %}

If you want to get information for more than one index, separate the indexes with commas:

GET _cat/indices/index1,index2,index3

{% include copy-curl.html %}

Example response

health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
green  | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb

Limiting the response size

To limit the number of indexes returned, configure the cat.indices.response.limit.number_of_indices setting. For more information, see Cluster-level CAT response limit settings.