› › ›

API создания или обновления алиаса

Добавляет поток данных или индекс к алиасу.

resp = client.indices.put_alias(
    index="my-data-stream",
    name="my-alias",
)
print(resp)

response = client.indices.put_alias(
  index: 'my-data-stream',
  name: 'my-alias'
)
puts response

const response = await client.indices.putAlias({
  index: "my-data-stream",
  name: "my-alias",
});
console.log(response);

PUT my-data-stream/_alias/my-alias

Запрос

POST <target>/_alias/<alias>

POST <target>/_aliases/<alias>

PUT <target>/_alias/<alias>

PUT <target>/_aliases/<alias>

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

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

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

<alias>: (Обязательно, строка) Алиас для обновления. Если алиас не существует, запрос создаёт его. Имена алиасов индексов поддерживают математику дат.
<target>: (Обязательно, строка) Список потоков данных или индексов, разделённых запятыми, для добавления. Поддерживаются подстановочные знаки (*). Шаблоны подстановки, которые соответствуют как потокам данных, так и индексам, возвращают ошибку.

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

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

Тело запроса

filter

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

index_routing

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

is_hidden

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

is_write_index

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

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

must_exist

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

routing

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

search_routing

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

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