В Elasticsearch под алиасом (псевдонимом) понимается альтернативное имя, присвоенное определенному ресурсу Elasticsearch, например, индексу или потоку данных. Псевдоним - это вторичное имя, которое может быть передано различным конечным точкам Elasticsearch API и выполнить действие над ресурсом. Основное назначение псевдонима - предотвращение коллизий имен, удобство или выполнение таких операций, как переиндексация, без простоя.
Хотя большинство конечных точек API в Elasticsearch поддерживают использование псевдонимов, есть несколько исключений, например, разрушительные API. Примером может служить API удаления индекса Elasticsearch.
Elasticsearch Создание псевдонима индекса
Прежде чем научиться получать псевдонимы заданного ресурса, давайте создадим простой псевдоним для индекса. Для создания псевдонима для заданного ресурса мы используем API aliases и действие as ADD.
Например, предположим, что у нас есть индекс с названием "earthquake". Чтобы добавить псевдоним к индексу, мы можем выполнить запрос, как показано ниже.
| 1 2 3 4 5 6 7 8 9 10 11 | curl -XPOST "http://localhost:9200/_aliases" -H "kbn-xsrf: reporting" -H "Content-Type: application/json" -d' { "actions": [ { "add": { "index": "earthquake", "alias": "quake" } } ] }' |
Приведенный запрос создает псевдоним "quake" для индекса "earthquake". В случае успешного выполнения запрос должен вернуть true:
| 1 2 3 | { "acknowledged": true } |
Просмотр псевдонимов кластера Elasticsearch
Для просмотра псевдонимов в кластере можно использовать API псевдонимов, как показано в приведенном ниже синтаксисе:
| 1 | GET _alias |
Обращение к конечной точке _alias без каких-либо параметров возвращает все псевдонимы в кластере. Пример показан ниже:
| 1 | curl -XGET "http://localhost:9200/_alias?pretty=true" -H "kbn-xsrf: reporting" |
Приведенный выше запрос должен вернуть все псевдонимы в кластере, как показано в примере ниже:
Как можно догадаться, ресурс может иметь более одного псевдонима.
Для получения списка псевдонимов в кластере мы также можем воспользоваться API cat. Синтаксис запроса выглядит следующим образом:
| 1 | GET _cat/aliases |
Например, чтобы показать все индексы в кластере в человекочитаемом виде, мы можем выполнить запрос следующим образом:
| 1 | curl -XGET "http://localhost:9200/_cat/aliases?v" -H "kbn-xsrf: reporting". |
Выходные данные:
Возвращается псевдоним, индекс или поток данных, которому принадлежит псевдоним, статус записи и т.д.
Elasticsearch Показать псевдонимы для заданного ресурса
Для просмотра псевдонимов, связанных с заданным ресурсом, можно использовать синтаксис запроса, показанный ниже:
| 1 | GET <resource>/_alias |
Где ресурс - это существующий индекс или поток данных.
Например, чтобы просмотреть псевдонимы индекса kibana_event_log, можно выполнить команду:
| 1 | curl -XGET "http://localhost:9200/.kibana-event-log-8.3.3/_alias?pretty" -H "kbn-xsrf: reporting". |
В результате будут возвращены псевдонимы, связанные с указанным индексом.
| 1 2 3 4 5 6 7 8 9 10 | { ".kibana-event-log-8.3.3-000001": { "aliases": { ".kibana-event-log-8.3.3": { "is_write_index": true, "is_hidden": true } } } } |
Elasticsearch Показать ресурсы, связанные с заданным псевдонимом
Вы также можете показать, какие ресурсы назначены определенному псевдониму, используя приведенный ниже синтаксис запроса:
| 1 | GET _alias/<alias> |
Например, чтобы показать, какой ресурс использует псевдоним "quake", мы можем выполнить запрос:
| 1 | curl -XGET "http://localhost:9200/_alias/quake?pretty" -H "kbn-xsrf: reporting". |
Приведенный выше запрос должен вернуть результат в виде:
| 1 2 3 4 5 6 7 | { "earthquake": { "aliases": { "quake": {} } } } |
Это указывает на то, что псевдоним "quake" назначен индексу "earthquake".
Заключение
В этой статье вы узнали, как просмотреть все псевдонимы в кластере с помощью API aliases and cat. Вы также узнали, как получить псевдонимы заданного ресурса и наоборот.