清理快照存储库 API编辑

触发对快照存储库内容的审查,并删除任何未被现有快照引用的过时数据。请参阅清理存储库

response = client.snapshot.cleanup_repository(
  repository: 'my_repository'
)
puts response
POST /_snapshot/my_repository/_cleanup

请求编辑

POST /_snapshot/<repository>/_cleanup

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则您必须拥有 manage 集群权限 才能使用此 API。

路径参数编辑

<repository>
(必填,字符串)要审查和清理的快照存储库的名称。

查询参数编辑

master_timeout
(可选,时间单位)等待主节点的时间。如果在超时到期之前主节点不可用,则请求失败并返回错误。默认为 30s。也可以设置为 -1 以指示请求永不超时。
timeout
(可选,时间单位)等待响应的时间。如果在超时到期之前未收到响应,则请求失败并返回错误。默认为 30s

响应正文编辑

results

(对象)包含清理操作的统计信息。

results 的属性
deleted_bytes
(整数)清理操作释放的字节数。
deleted_blobs
(整数)在清理操作期间从快照存储库中删除的二进制大对象 (blob) 数量。任何非零值都意味着找到了未引用的 blob,并随后将其清理。

示例编辑

response = client.snapshot.cleanup_repository(
  repository: 'my_repository'
)
puts response
POST /_snapshot/my_repository/_cleanup

API 返回以下响应

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