スナップショットリポジトリ削除API

1つ以上の スナップショットリポジトリ の登録を解除します。

リポジトリが登録解除されると、Elasticsearchはスナップショットを保存しているリポジトリの場所への参照のみを削除します。スナップショット自体はそのまま残ります。

Python

  1. resp = client.snapshot.delete_repository(
  2. name="my_repository",
  3. )
  4. print(resp)

Ruby

  1. response = client.snapshot.delete_repository(
  2. repository: 'my_repository'
  3. )
  4. puts response

Js

  1. const response = await client.snapshot.deleteRepository({
  2. name: "my_repository",
  3. });
  4. console.log(response);

コンソール

  1. DELETE /_snapshot/my_repository

リクエスト

DELETE /_snapshot/<repository>

前提条件

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

パスパラメータ

  • <repository>
  • (必須、文字列) 登録解除するスナップショットリポジトリの名前。ワイルドカード (*) パターンがサポートされています。

クエリパラメータ

  • master_timeout
  • (オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは 30s です。リクエストがタイムアウトしないことを示すために -1 に設定することもできます。
  • timeout
  • (オプション、時間単位) クラスターのメタデータを更新した後、クラスター内のすべての関連ノードからの応答を待機する期間。タイムアウトが切れる前に応答が受信されない場合、クラスターのメタデータの更新は適用されますが、応答は完全に承認されなかったことを示します。デフォルトは 30s です。リクエストがタイムアウトしないことを示すために -1 に設定することもできます。