› › ›

API алиаса существует

Проверяет, существует ли алиас.

resp = client.indices.exists_alias(
    name="my-alias",
)
print(resp)

response = client.indices.exists_alias(
  name: 'my-alias'
)
puts response

const response = await client.indices.existsAlias({
  name: "my-alias",
});
console.log(response);

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/8.17/indices-alias-exists.html