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

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

Справочник по новым API

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

Удаляет один или несколько индексов.

resp = client.indices.delete(
    index="my-index-000001",
)
print(resp)
response = client.indices.delete(
  index: 'my-index-000001'
)
puts response
const response = await client.indices.delete({
  index: "my-index-000001",
});
console.log(response);
DELETE /my-index-000001

Запрос

DELETE /<index>

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

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

Описание

Удаление индекса удаляет его документы, фрагменты и метаданные. Оно не удаляет связанные компоненты Kibana, такие как представления данных, визуализации или панели мониторинга.

Вы не можете удалить текущий индекс записи потока данных. Для удаления индекса необходимо перезаписать поток данных, чтобы создать новый индекс записи. После этого вы можете использовать API удаления индекса для удаления предыдущего индекса записи.

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

<index>

(Обязательный, строка) Список индексов для удаления, разделённых запятыми. Вы не можете указать алиасы индексов.

По умолчанию этот параметр не поддерживает подстановочные знаки (*) или _all. Чтобы использовать подстановочные знаки или _all, установите кластерный параметр action.destructive_requires_name в значение false.

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

allow_no_indices

(Необязательный, булево) Если false, запрос возвращает ошибку, если какой-либо шаблон подстановки, алиас индекса или _all значение нацелены только на отсутствующие или закрытые индексы. Это поведение действует даже если запрос направлен на другие открытые индексы. Например, запрос, нацеленный на foo*,bar*, возвращает ошибку, если индекс начинается с foo, но ни один индекс не начинается с bar.

По умолчанию значение true.

expand_wildcards

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

all
Совпадение с любым потоком данных или индексом, включая скрытые.
open
Совпадение с открытыми, не скрытыми индексами. Также совпадение с любым не скрытым потоком данных.
closed
Совпадение с закрытыми, не скрытыми индексами. Также совпадение с любым не скрытым потоком данных. Потоки данных не могут быть закрыты.
hidden
Совпадение со скрытыми потоками данных и скрытыми индексами. Должно использоваться в сочетании с open, closed или обоими.
none
Шаблоны подстановки не принимаются.

По умолчанию значение open,closed.

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

Spec-Zone.ru

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