› › ›

API получения информации об индексе

Возвращает информацию об одном или нескольких индексах. Для потоков данных API возвращает информацию об индексах, которые служат основой для потока.

GET /my-index-000001

До версии 7.0.0 определение mappings включало имя типа. Хотя отображения в ответах больше по умолчанию не содержат имени типа, вы по-прежнему можете запросить старый формат с помощью параметра include_type_name. Подробнее см. Удаление типов отображений.

Запрос

GET /<target>

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

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

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

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

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

allow_no_indices

(Необязательный, логическое значение) Если false, запрос возвращает ошибку, если какое-либо подстановочное выражение, псевдоним индекса или _all значение задают только отсутствующие или закрытые индексы. Это поведение применяется даже в том случае, если запрос задаёт другие открытые индексы. Например, запрос, направленный на foo*,bar*, возвращает ошибку, если индекс начинается с foo, но ни один индекс не начинается с bar.

По умолчанию true.

expand_wildcards

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

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

По умолчанию open.

flat_settings

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

include_defaults

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

include_type_name

[7.0.0] Устарело в версии 7.0.0. Типы отображений устарели. См. Удаление типов отображений. (Необязательный, булево значение) Если true, ожидается тип отображения в теле отображений. По умолчанию false.

ignore_unavailable

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

local

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

master_timeout

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

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