スナップショットリポジトリの取得（Get snapshot repository）

スナップショットリポジトリAPIの取得

登録された スナップショットリポジトリ に関する情報を取得します。

Python

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

Ruby

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

Js

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

コンソール

GET /_snapshot/my_repository

リクエスト

GET /_snapshot/<repository>

GET /_snapshot

前提条件

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

パスパラメータ

• <repository>
• （オプション、文字列）リクエストを制限するために使用されるスナップショットリポジトリ名のカンマ区切りリスト。ワイルドカード（*）式がサポートされており、- で始まる除外パターンとワイルドカードを組み合わせることができます。
  クラスターに登録されているすべてのスナップショットリポジトリに関する情報を取得するには、このパラメータを省略するか、* または _all を使用します。

クエリパラメータ

• local
• （オプション、ブール値）true の場合、リクエストはローカルノードからのみ情報を取得します。false の場合、リクエストはマスターノードから情報を取得します。デフォルトは false です。
• master_timeout
• （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは 30s です。リクエストがタイムアウトしないことを示すために -1 に設定することもできます。

レスポンスボディ

• <repository>
• （オブジェクト）スナップショットリポジトリに関する情報を含みます。キーはスナップショットリポジトリの名前です。
  <repository> のプロパティ
  • type
  • （文字列）リポジトリタイプ。
    type の値
    • fs
    • 共有ファイルシステムリポジトリ。 共有ファイルシステムリポジトリを参照してください。
    • source
    • ソース専用リポジトリ。 ソース専用リポジトリを参照してください。
    • url
    • URLリポジトリ。 読み取り専用URLリポジトリを参照してください。
      これらの公式プラグインを通じて、さらに多くのリポジトリタイプが利用可能です：
    • repository-s3 S3リポジトリサポート
    • repository-hdfs Hadoop環境におけるHDFSリポジトリサポート
    • repository-azure Azureストレージリポジトリ
    • repository-gcs Google Cloud Storageリポジトリ
  • settings
  • （オブジェクト）リポジトリの設定を含みます。settings オブジェクトの有効なプロパティは、typeパラメータを使用して設定されたリポジトリタイプに依存します。
    プロパティについては、スナップショットリポジトリの作成または更新APIの settings パラメータを参照してください。

例

Python

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

Ruby

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

Js

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

コンソール

GET /_snapshot/my_repository

APIは次のレスポンスを返します：

コンソール-結果

{
  "my_repository" : {
   "type" : "fs",
   "uuid" : "0JLknrXbSUiVPuLakHjBrQ",
   "settings" : {
   "location" : "my_backup_location"
   }
  }
}