› › ›

API Exists

Проверяет, существует ли поток данных, индекс или алиас.

HEAD my-data-stream

Запрос

HEAD <target>

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

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

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

<target>: (Необязательно, строка) Список потоков данных, индексов и алиасов, разделённых запятыми. Поддерживаются подстановки (*).

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

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.

ignore_unavailable

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

local

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

Коды ответов

200: Все целевые объекты существуют.
404: Один или несколько указанных целевых объектов не существуют.

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