Alice Williams fe8d702ca9
add operation to titles to differentiate from the API group acronym (#1750)
* add operation to titles to differentiate from the API group acronym

Signed-off-by: alicejw <alicejw@amazon.com>

* update frontmatter with new page title

Signed-off-by: alicejw <alicejw@amazon.com>

* for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713

Signed-off-by: alicejw <alicejw@amazon.com>

* to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly

Signed-off-by: alicejw <alicejw@amazon.com>

* to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-10-31 09:21:32 -07:00

1009 B

layout title parent nav_order has_children
default CAT count CAT API 10 false

CAT count

Introduced 1.0 {: .label .label-purple }

The CAT count operation lists the number of documents in your cluster.

Example

GET _cat/count?v

To see the number of documents in a specific index or alias, add the index or alias name after your query:

GET _cat/count/<index_or_alias>?v

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

GET _cat/aliases/index_or_alias_1,index_or_alias_2,index_or_alias_3

Path and HTTP methods

GET _cat/count?v
GET _cat/count/<index>?v

URL parameters

All CAT count URL parameters are optional. You can specify any of the common URL parameters.

Response

The following response shows the overall document count as 1625:

epoch      | timestamp | count
1624237738 | 01:08:58  | 1625