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 the count API.
Provides quick access to a document count for a data stream, an index, or an entire cluster.
The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
-
If the Elasticsearch security features are enabled, you must have the
readindex privilege for any data stream, index, or alias you retrieve.
-
<target> -
(Optional, string) 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.
-
format - (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
h - (Optional, string) Comma-separated list of column names to display.
-
help -
(Optional, Boolean) If
true, the response includes help information. Defaults tofalse. -
s - (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
v -
(Optional, Boolean) If
true, the response includes column headings. Defaults tofalse.
The following count API request retrieves the document count for the
my-index-000001 data stream or index.
resp = client.cat.count(
index="my-index-000001",
v=True,
)
print(resp)
response = client.cat.count( index: 'my-index-000001', v: true ) puts response
const response = await client.cat.count({
index: "my-index-000001",
v: "true",
});
console.log(response);
GET /_cat/count/my-index-000001?v=true
The API returns the following response:
epoch timestamp count 1475868259 15:24:20 120
The following count API request retrieves the document count for all data
streams and indices in the cluster.
resp = client.cat.count(
v=True,
)
print(resp)
response = client.cat.count( v: true ) puts response
const response = await client.cat.count({
v: "true",
});
console.log(response);
GET /_cat/count?v=true
The API returns the following response:
epoch timestamp count 1475868259 15:24:20 121