› › ›

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

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

resp = client.indices.get_alias(
    index="my-data-stream",
    name="my-alias",
)
print(resp)

response = client.indices.get_alias(
  index: 'my-data-stream',
  name: 'my-alias'
)
puts response

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

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