› › ›

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

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

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

Тело запроса

filter

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

index_routing

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

is_hidden

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

is_write_index

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

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

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