› › ›

API cat count

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

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

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

Запрос

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 потока данных или индекса.

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

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

epoch      timestamp count
1475868259 15:24:20  120

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

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

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

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/8.17/cat-count.html