› › ›

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

Получает информацию об одном или нескольких алиасах.

GET my-data-stream/_alias/my-alias

Запрос

GET _alias/<alias>

GET _alias

GET <target>/_alias/<alias>

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

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

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

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

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

allow_no_indices

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

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

expand_wildcards

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

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

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

ignore_unavailable

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

local

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

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