› › ›

API существования псевдонима

Проверяет существование псевдонима.

HEAD _alias/my-alias

Запрос

HEAD _alias/<alias>

HEAD <target>/_alias/<alias>

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

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

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

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

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

expand_wildcards

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

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

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

ignore_unavailable

(Необязательно, булево) Если false, запросы, содержащие отсутствующий поток данных или индекс в <target>, возвращают ошибку. По умолчанию 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-alias-exists.html