スナップショットリポジトリAPIの作成または更新

スナップショットリポジトリを登録または更新します。

Python

  1. resp = client.snapshot.create_repository(
  2.    name="my_repository",
  3.    repository={
  4.    "type": "fs",
  5.    "settings": {
  6.    "location": "my_backup_location"
  7.    }
  8.    },
  9. )
  10. print(resp)

Ruby

  1. response = client.snapshot.create_repository(
  2.   repository: 'my_repository',
  3.   body: {
  4.    type: 'fs',
  5.    settings: {
  6.    location: 'my_backup_location'
  7.    }
  8.   }
  9. )
  10. puts response

Js

  1. const response = await client.snapshot.createRepository({
  2.   name: "my_repository",
  3.   repository: {
  4.    type: "fs",
  5.    settings: {
  6.    location: "my_backup_location",
  7.    },
  8.   },
  9. });
  10. console.log(response);

コンソール

  1. PUT /_snapshot/my_repository
  2. {
  3.   "type": "fs",
  4.   "settings": {
  5.    "location": "my_backup_location"
  6.   }
  7. }

検索可能なスナップショットを移行する場合、リポジトリの名前はソースクラスターと宛先クラスターで同一でなければなりません。

リクエスト

PUT /_snapshot/<repository>

POST /_snapshot/<repository>

前提条件

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

  • スナップショットリポジトリを登録するには、クラスターのグローバルメタデータが書き込み可能である必要があります。書き込みアクセスを妨げるクラスターブロックがないことを確認してください。

パスパラメータ

  • <repository>
  • (必須、文字列) 登録または更新するスナップショットリポジトリの名前。

クエリパラメータ

このAPIのいくつかのオプションは、クエリパラメータまたはリクエストボディパラメータを使用して指定できます。両方のパラメータが指定された場合、クエリパラメータのみが使用されます。

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

リクエストボディ