› › ›

API очистки хранилища снимков

Вызывает проверку содержимого хранилища снимков и удаляет устаревшие данные, на которые не ссылаются существующие снимки. См. Очистка хранилища.

resp = client.snapshot.cleanup_repository(
    name="my_repository",
)
print(resp)

response = client.snapshot.cleanup_repository(
  repository: 'my_repository'
)
puts response

const response = await client.snapshot.cleanupRepository({
  name: "my_repository",
});
console.log(response);

POST /_snapshot/my_repository/_cleanup

Запрос

POST /_snapshot/<repository>/_cleanup

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

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

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

<repository>: (Обязательно, строка) Имя хранилища снимков, которое нужно проверить и очистить.

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

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

Тело ответа

results

(объект) Содержит статистику операций очистки.

Свойства results

deleted_bytes: (целое число) Количество освобождённых байт в результате операций очистки.
deleted_blobs: (целое число) Количество удалённых бинарных больших объектов (BLOB) из хранилища снимков во время операций очистки. Любое ненулевое значение подразумевает, что были найдены неиспользуемые BLOB-ы, которые были затем очищены.

Примеры

resp = client.snapshot.cleanup_repository(
    name="my_repository",
)
print(resp)

response = client.snapshot.cleanup_repository(
  repository: 'my_repository'
)
puts response

const response = await client.snapshot.cleanupRepository({
  name: "my_repository",
});
console.log(response);

POST /_snapshot/my_repository/_cleanup

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

{
  "results": {
    "deleted_bytes": 20,
    "deleted_blobs": 5
  }
}

© 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/clean-up-snapshot-repo-api.html