Spec-Zone.ru › Elasticsearch 8
›Руководство по Elasticsearch [8.17] ›REST API ›API компактного и выровненного текста (CAT)

API cat indices

Справочник нового API

Для получения самых свежих данных об API обратитесь к API компактного и выровненного текста (CAT).

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.
master_timeout
(Необязательный, единицы измерения времени) Время ожидания для узла мастера. Если узел мастера недоступен до истечения срока ожидания, запрос завершается ошибкой и возвращает ошибку. По умолчанию 30s. Также может быть установлено на -1, чтобы указать, что запрос никогда не должен превышать срок ожидания.
pri (первичные фрагменты)
(Необязательный, булево) Если true, ответ содержит только информацию из первичных фрагментов. По умолчанию false.
s
(Необязательный, строка) Список имен столбцов или псевдонимов столбцов, разделенных запятыми, используемых для сортировки ответа.
time
(Необязательный, единицы измерения времени) Единица измерения, используемая для отображения значений времени.
v
(Необязательный, булево) Если true, ответ включает заголовки столбцов. По умолчанию false.
expand_wildcards

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

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

Примеры

resp = client.cat.indices(
    index="my-index-*",
    v=True,
    s="index",
)
print(resp)
response = client.cat.indices(
  index: 'my-index-*',
  v: true,
  s: 'index'
)
puts response
const response = await client.cat.indices({
  index: "my-index-*",
  v: "true",
  s: "index",
});
console.log(response);
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 dataset.size
yellow open   my-index-000001  u8FNjxh8Rfy_awN11oDKYQ   1   1       1200            0     88.1kb         88.1kb       88.1kb
green  open   my-index-000002  nYFWZEO7TUiOjLQXBaYJpA   1   0          0            0       260b           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/8.17/cat-indices.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API