› › ›

API cat indices

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

Возвращает информацию высокого уровня об индексах в кластере, включая базовые индексы для потоков данных.

Запрос

GET /_cat/indices/<target>

GET /_cat/indices

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

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

Описание

Используйте API cat indices, чтобы получить следующую информацию для каждого индекса в кластере:

Количество фрагментов
Количество документов
Количество удаленных документов
Размер первичного хранилища
Общий размер хранилища всех фрагментов, включая фрагментные реплики

Эти метрики извлекаются непосредственно из Lucene, который Elasticsearch использует для индексирования и поиска. В результате все подсчеты документов включают скрытые вложенные документы.

Чтобы получить точный подсчет документов Elasticsearch, используйте API cat count или count.

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

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

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

bytes

(Необязательно, единицы измерения размера байтов) Единица измерения, используемая для отображения значений байтов.

format

(Необязательно, строка) Короткое представление заголовка HTTP accept. Допустимые значения включают JSON, YAML и т. д.

h

(Необязательно, строка) Список имен столбцов, разделенных запятыми, для отображения.

health

(Необязательно, строка) Состояние работоспособности, используемое для ограничения возвращаемых индексов. Допустимые значения:

green
yellow
red

По умолчанию ответ включает индексы любого состояния работоспособности.

help

(Необязательно, булево) Если true, ответ включает справочную информацию. По умолчанию false.

include_unloaded_segments

(Необязательно, булево) Если true, ответ включает информацию из сегментов, которые не загружены в память. По умолчанию false.

local

(Необязательно, булево)

Устарело в версии 7.11.0.

Этот параметр не влияет на запрос. Он будет удален в будущей версии.

master_timeout

(Необязательно, единицы измерения времени) Время ожидания подключения к узлу мастера. Если ответ не получен до истечения времени ожидания, запрос завершается ошибкой и возвращает ошибку. По умолчанию 30s.

pri (первичные фрагменты)

(Необязательно, булево) Если true, ответ содержит только информацию от первичных фрагментов. По умолчанию false.

s

(Необязательно, строка) Список имён столбцов или псевдонимов столбцов, разделенных запятыми, для сортировки ответа.

time

(Необязательно, единицы измерения времени) Единица измерения, используемая для отображения значений времени.

v

(Необязательно, булево) Если true, ответ включает заголовки столбцов. По умолчанию false.

expand_wildcards

(Необязательно, строка) Тип индекса, которому подстановочные знаки могут соответствовать. Если запрос может нацеливаться на потоки данных, этот аргумент определяет, соответствуют ли выражения подстановки скрытым потокам данных. Поддерживаются значения, разделенные запятыми, такие как open,hidden. Допустимые значения:

all: Соответствовать любому потоку данных или индексу, включая скрытые.
open: Соответствовать открытым, не скрытым индексам. Также соответствует любому не скрытому потоку данных.
closed: Соответствовать закрытым, не скрытым индексам. Также соответствует любому не скрытому потоку данных. Потоки данных не могут быть закрыты.
hidden: Соответствовать скрытым потокам данных и скрытым индексам. Должен быть объединён с open, closed или обоими.
none: Подстановочные знаки не принимаются.

Примеры

GET /_cat/indices/my-index-*?v=true&s=index

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

health status index            uuid                   pri rep docs.count docs.deleted store.size pri.store.size
yellow open   my-index-000001  u8FNjxh8Rfy_awN11oDKYQ   1   1       1200            0     88.1kb         88.1kb
green  open   my-index-000002  nYFWZEO7TUiOjLQXBaYJpA   1   0          0            0       260b           260b

© 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-indices.html