MUHAMMAD SAMIULLAH 84e4ab158e
[DOC] Format all API pages according to the API template (#5169)
* Fix APIs File

Signed-off-by: samipak458 <samipak458@gmail.com>

* Update API files according to API template

Signed-off-by: samipak458 <samipak458@gmail.com>

* Update exec-stored-script.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update cat-aliases.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-allocation.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-cluster_manager.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-count.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-field-data.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-health.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* updated

* updated

* updated

---------

Signed-off-by: samipak458 <samipak458@gmail.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-10-23 09:53:52 -05:00

1.1 KiB

layout title parent nav_order has_children redirect_from
default CAT count CAT API 10 false
/opensearch/rest-api/cat/cat-count/

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

{% include copy-curl.html %}

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

{% include copy-curl.html %}

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

GET _cat/count/index_or_alias_1,index_or_alias_2,index_or_alias_3

{% include copy-curl.html %}

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