52 lines
1.0 KiB
Markdown
52 lines
1.0 KiB
Markdown
|
---
|
||
|
|
layout: default
|
||
|
|
title: cat count
|
||
|
|
parent: CAT
|
||
|
|
grand_parent: REST API reference
|
||
|
|
nav_order: 10
|
||
|
|
has_children: false
|
||
|
|
---
|
||
|
|
|
||
|
|
# cat count
|
||
|
|
|
||
|
|
The cat count operation lists the number of documents in your cluster.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```json
|
||
|
|
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:
|
||
|
|
|
||
|
|
```json
|
||
|
|
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:
|
||
|
|
|
||
|
|
```json
|
||
|
|
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]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters).
|
||
|
|
|
||
|
|
|
||
|
|
## Response
|
||
|
|
|
||
|
|
The following response shows the overall document count as 1625:
|
||
|
|
|
||
|
|
```json
|
||
|
|
epoch | timestamp | count
|
||
|
|
1624237738 | 01:08:58 | 1625
|
||
|
|
```
|