删除快照 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

示例

编辑

以下请求从名为 my_repository 的存储库中删除 snapshot_2snapshot_3

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
}