› › ›

API cat count

API cat предназначены только для использования человеком через командную строку или консоль Kibana. Они не предназначены для использования приложениями. Для использования приложениями используйте API подсчета.

Обеспечивает быстрый доступ к количеству документов для потока данных, индекса или всего кластера.

Количество документов включает только активные документы, а не удалённые, которые ещё не были удалены процессом слияния.

Запрос

GET /_cat/count/<target>

GET /_cat/count

Предварительные условия

Если функции безопасности Elasticsearch включены, у вас должен быть read доступ к индексам для любого потока данных, индекса или псевдонима, которые вы получаете.

Параметры пути

<target>: (Необязательный, строка) Список потоков данных, индексов и псевдонимов, разделенных запятыми, используемых для ограничения запроса. Поддерживает подстановочные знаки (*). Для целей всего потоков данных и индексов опустите этот параметр или используйте * или _all.

Параметры запроса

format: (Необязательный, строка) Короткая версия заголовка HTTP accept. Допустимые значения включают JSON, YAML и т. д.
h: (Необязательный, строка) Список имен столбцов, разделенных запятыми, для отображения.
help: (Необязательный, булево) Если true, ответ включает справочную информацию. По умолчанию false.
s: (Необязательный, строка) Список имен столбцов или псевдонимов столбцов, разделенных запятыми, для сортировки ответа.
v: (Необязательный, булево) Если true, ответ включает заголовки столбцов. По умолчанию false.

Примеры

Пример с отдельным потоком данных или индексом

Следующий запрос count API возвращает количество документов для my-index-000001 потока данных или индекса.

GET /_cat/count/my-index-000001?v=true

API возвращает следующий ответ:

epoch      timestamp count
1475868259 15:24:20  120

Пример со всеми потоками данных и индексами в кластере

Следующий запрос count API возвращает количество документов для всех потоков данных и индексов в кластере.

GET /_cat/count?v=true

API возвращает следующий ответ:

epoch      timestamp count
1475868259 15:24:20  121

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cat-count.html