› › ›

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: Шаблоны подстановок не принимаются.

Примеры

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