› › ›

API алиасов

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

resp = client.indices.update_aliases(
    actions=[
        {
            "add": {
                "index": "my-data-stream",
                "alias": "my-alias"
            }
        }
    ],
)
print(resp)

response = client.indices.update_aliases(
  body: {
    actions: [
      {
        add: {
          index: 'my-data-stream',
          alias: 'my-alias'
        }
      }
    ]
  }
)
puts response

const response = await client.indices.updateAliases({
  actions: [
    {
      add: {
        index: "my-data-stream",
        alias: "my-alias",
      },
    },
  ],
});
console.log(response);

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

Запрос

POST _aliases

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

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

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

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

Тело запроса

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, удаление несуществующего алиаса приведёт к отказу только этого удаления. По умолчанию false.

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

routing

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

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

search_routing

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

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

Тело ответа

acknowledged

(Булево) Если true, запрос получил ответ от узла-мастера в течение timeout периода.

errors

(Булево) Если true, по крайней мере, одно из запрошенных действий завершилось неудачно.

action_results

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

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

action

(объект) Описание связанного запроса действия.

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

type: (строка) Тип связанного действия, один из add, remove или remove_index.
indices: (массив строк) Список индексов в связанном действии.
aliases: (массив строк) Список псевдонимов в связанном действии.

status

(целое число) Код HTTP-статуса, возвращённый для действия.

error

(Необязательный, объект) Содержит дополнительную информацию о неудачном действии.

Присутствует только если действие завершилось неудачно.

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