› › ›

API удаления моментального снимка

resp = client.snapshot.delete(
    repository="my_repository",
    snapshot="my_snapshot",
)
print(resp)

response = client.snapshot.delete(
  repository: 'my_repository',
  snapshot: 'my_snapshot'
)
puts response

const response = await client.snapshot.delete({
  repository: "my_repository",
  snapshot: "my_snapshot",
});
console.log(response);

DELETE /_snapshot/my_repository/my_snapshot

Запрос

DELETE /_snapshot/<repository>/<snapshot>

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

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

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

<repository>: (Обязательно, строка) Название хранилища, из которого нужно удалить моментальный снимок.
<snapshot>: (Обязательно, строка) Список имен моментальных снимков для удаления, разделенных запятыми. Также поддерживаются подстановочные знаки (*).

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

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

Пример

Следующий запрос удаляет snapshot_2 и snapshot_3 из хранилища с именем my_repository.

resp = client.snapshot.delete(
    repository="my_repository",
    snapshot="snapshot_2,snapshot_3",
)
print(resp)

response = client.snapshot.delete(
  repository: 'my_repository',
  snapshot: 'snapshot_2,snapshot_3'
)
puts response

const response = await client.snapshot.delete({
  repository: "my_repository",
  snapshot: "snapshot_2,snapshot_3",
});
console.log(response);

DELETE /_snapshot/my_repository/snapshot_2,snapshot_3

API возвращает следующий ответ:

{
  "acknowledged" : true
}

© 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/delete-snapshot-api.html