スナップショットの削除（Delete snapshot）

スナップショット削除API

スナップショットを削除します snapshot。

Python

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

Ruby

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

Js

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のセキュリティ機能が有効になっている場合、このAPIを使用するには、manage クラスター権限が必要です。

パスパラメータ

• <repository>
• (必須、文字列) スナップショットを削除するリポジトリの名前。
• <snapshot>
• (必須、文字列) 削除するスナップショット名のカンマ区切りリスト。ワイルドカードも受け付けます (*)。

クエリパラメータ

• master_timeout
• (オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは 30s です。リクエストがタイムアウトしないことを示すために -1 に設定することもできます。
• wait_for_completion
• (オプション、ブール値) true の場合、リクエストは一致するスナップショットがすべて削除されたときに応答を返します。false の場合、削除がスケジュールされるとすぐにリクエストは応答を返します。デフォルトは true です。

例

次のリクエストは、リポジトリ名 my_repository から snapshot_2 と snapshot_3 を削除します。

Python

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

Ruby

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

Js

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
}