› › ›

API получения индекса

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

resp = client.indices.get(
    index="my-index-000001",
)
print(resp)

response = client.indices.get(
  index: 'my-index-000001'
)
puts response

const response = await client.indices.get({
  index: "my-index-000001",
});
console.log(response);

GET /my-index-000001

Запрос

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.

features

(Необязательный, строка) Возвращение информации о конкретных функциях индекса. Поддерживаются значения через запятую. Допустимые значения aliases, mappings и settings. По умолчанию aliases,mappings,settings.

flat_settings

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

include_defaults

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

ignore_unavailable

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

local

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

master_timeout

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

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