Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API индексов

API удаления алиаса

Новая справка по API

Для получения самых последних данных об API, обратитесь к API индексов.

Удаляет поток данных или индекс из алиаса.

resp = client.indices.delete_alias(
    index="my-data-stream",
    name="my-alias",
)
print(resp)
response = client.indices.delete_alias(
  index: 'my-data-stream',
  name: 'my-alias'
)
puts response
const response = await client.indices.deleteAlias({
  index: "my-data-stream",
  name: "my-alias",
});
console.log(response);
DELETE my-data-stream/_alias/my-alias

Запрос

DELETE <target>/_alias/<alias>

DELETE <target>/_aliases/<alias>

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

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

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

<alias>
(Обязательно, строка) Список алиасов, которые необходимо удалить, через запятую. Поддерживаются подстановочные знаки (*). Для удаления всех алиасов используйте * или _all.
<target>
(Обязательно, строка) Список потоков данных или индексов, используемых для ограничения запроса, через запятую. Поддерживаются подстановочные знаки (*).

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

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API