スナップショットリポジトリのクリーンアップ（Clean up snapshot repository）

スナップショットリポジトリのクリーンアップAPI

スナップショットリポジトリの内容をレビューし、既存のスナップショットによって参照されていない古いデータを削除します。詳細はリポジトリのクリーンアップを参照してください。

Python

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

Ruby

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

Js

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

コンソール

POST /_snapshot/my_repository/_cleanup

リクエスト

POST /_snapshot/<repository>/_cleanup

前提条件

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

パスパラメータ

• <repository>
• （必須、文字列）レビューしてクリーンアップするスナップショットリポジトリの名前。

クエリパラメータ

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

レスポンスボディ

• results
• （オブジェクト）クリーンアップ操作の統計を含みます。

  -   `````deleted_bytes

  • （整数）クリーンアップ操作によって解放されたバイト数。
  • deleted_blobs
  • （整数）クリーンアップ操作中にスナップショットリポジトリから削除されたバイナリ大オブジェクト（BLOB）の数。非ゼロの値は、参照されていないBLOBが見つかり、その後クリーンアップされたことを示します。

例

Python

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

Ruby

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

Js

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
  }
}