› › ›

API cat aliases

API cat предназначены только для использования человеком с помощью командной строки или консоли Kibana. Они не предназначены для использования приложениями. Для использования приложениями используйте API aliases.

Извлекает алиасы индексов кластера, включая информацию о фильтрах и маршрутизации. API не возвращает алиасы потоков данных.

Запрос

GET _cat/aliases/<alias>

GET _cat/aliases

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

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

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

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

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

format

(Необязательно, строка) Короткая версия заголовка HTTP accept. Допустимые значения включают JSON, YAML и т. д.

h

(Необязательно, строка) Список имен столбцов, разделенных запятыми, для отображения.

help

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

local

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

s

(Необязательно, строка) Список имен столбцов или псевдонимов столбцов, разделенных запятыми, используемых для сортировки ответа.

v

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

expand_wildcards

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

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

Примеры

resp = client.cat.aliases(
    v=True,
)
print(resp)

response = client.cat.aliases(
  v: true
)
puts response

const response = await client.cat.aliases({
  v: "true",
});
console.log(response);

GET _cat/aliases?v=true

API возвращает следующий ответ:

alias  index filter routing.index routing.search is_write_index
alias1 test1 -      -            -              -
alias2 test1 *      -            -              -
alias3 test1 -      1            1              -
alias4 test1 -      2            1,2            -

Этот ответ показывает, что alias2 настроил фильтр и определенные конфигурации маршрутизации в alias3 и alias4.

Если вам нужно получить информацию только о конкретных алиасах, вы можете указать алиасы в формате, разделенном запятыми, в качестве параметра URL, например, /_cat/aliases/alias1,alias2.

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