› › ›

API псевдонимов

Выполняет одно или несколько действий с псевдонимами в одной атомарной операции.

POST _aliases
{
  "actions": [
    {
      "add": {
        "index": "my-data-stream",
        "alias": "my-alias"
      }
    }
  ]
}

Запрос

POST _aliases

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

Если включены функции безопасности Elasticsearch, у вас должны быть следующие права на доступ к индексам:
- Для использования действия add или remove, у вас должно быть право доступа manage к псевдониму и его потокам данных или индексам.
- Для использования действия remove_index, у вас должно быть право доступа manage к индексу.

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

master_timeout: (Необязательно, единицы измерения времени) Время ожидания подключения к мастер-узлу. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.
timeout: (Необязательно, единицы измерения времени) Время ожидания ответа. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.

Тело запроса

actions

(Обязательно, массив объектов) Действия для выполнения.

Свойства объектов actions

<action>

(Обязательно, объект) Ключ — тип действия. Требуется хотя бы одно действие.

Допустимые ключи <action>

add: Добавляет поток данных или индекс к псевдониму. Если псевдоним не существует, действие add создаёт его.
remove: Удаляет поток данных или индекс из псевдонима.
remove_index: Удаляет индекс. Это действие нельзя использовать для псевдонимов или потоков данных.

Тело объекта содержит параметры для псевдонима. Поддерживает пустой объект.

Свойства <action>

alias: (Обязательно*, строка) Псевдоним для действия. Имена псевдонимов индексов поддерживают математику дат. Если aliases не указано, для действий add и remove этот параметр обязателен. Для действия remove этот параметр поддерживает подстановку шаблонов (*). Действие remove_index не поддерживает этот параметр.
aliases: (Обязательно*, массив строк) Псевдонимы для действия. Имена псевдонимов индексов поддерживают математику дат. Если alias не указано, для действий add и remove этот параметр обязателен. Для действия remove этот параметр поддерживает подстановку шаблонов (*). Действие remove_index не поддерживает этот параметр.

filter

(Необязательно, объект Query DSL) Запрос, используемый для ограничения документов, к которым может получить доступ псевдоним.

Только действие add поддерживает этот параметр.

index

(Обязательно*, строка) Поток данных или индекс для действия. Поддерживает подстановку шаблонов (*). Если indices не указано, этот параметр обязателен. Для действий add и remove_index шаблоны подстановки, соответствующие и потокам данных, и индексам, приводят к ошибке.

indices

(Обязательно*, массив строк) Потоки данных или индексы для действия. Поддерживает подстановку шаблонов (*). Если index не указано, этот параметр обязателен. Для действий add и remove_index шаблоны подстановки, соответствующие и потокам данных, и индексам, приводят к ошибке.

index_routing

(Необязательно, строка) Значение, используемое для маршрутизации операций индексирования на определённый фрагмент. Если указано, это значение переопределяет значение routing для операций индексирования. Псевдонимы потоков данных не поддерживают этот параметр.

Только действие add поддерживает этот параметр.

is_hidden

(Необязательно, логическое значение) Если true, псевдоним скрыт. По умолчанию false. Все потоки данных или индексы для псевдонима должны иметь одинаковое значение is_hidden.

Только действие add поддерживает этот параметр.

is_write_index

(Необязательно, логическое значение) Если true, устанавливает индекс или поток данных для записи для псевдонима.

Если псевдоним указывает на несколько индексов или потоков данных, и is_write_index не установлено, псевдоним отклоняет запросы на запись. Если псевдоним индекса указывает на один индекс и is_write_index не установлено, индекс автоматически выступает в качестве индекса записи. Псевдонимы потоков данных не автоматически устанавливают поток данных для записи, даже если псевдоним указывает на один поток данных.

Только действие add поддерживает этот параметр.

must_exist

(Необязательно, логическое значение) Если true, псевдоним должен существовать для выполнения действия. По умолчанию false. Только действие remove поддерживает этот параметр.

routing

(Необязательно, строка) Значение, используемое для маршрутизации операций индексирования и поиска на определённый фрагмент. Псевдонимы потоков данных не поддерживают этот параметр.

Только действие add поддерживает этот параметр.

search_routing

(Необязательно, строка) Значение, используемое для маршрутизации операций поиска на определённый фрагмент. Если указано, это значение переопределяет значение routing для операций поиска. Псевдонимы потоков данных не поддерживают этот параметр.

Только действие add поддерживает этот параметр.

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