スナップショットAPIの取得

1つ以上のスナップショットに関する情報を取得します。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="my_snapshot",
  4. )
  5. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: 'my_snapshot'
  4. )
  5. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "my_snapshot",
  4. });
  5. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/my_snapshot

リクエスト

GET /_snapshot/<repository>/<snapshot>

前提条件

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

パスパラメータ

  • <repository>
  • (必須、文字列) リクエストを制限するために使用されるスナップショットリポジトリ名のカンマ区切りリスト。ワイルドカード(*)式がサポートされており、-で始まる除外パターンとワイルドカードを組み合わせることができます。
    クラスターに登録されているすべてのスナップショットリポジトリに関する情報を取得するには、このパラメータを省略するか、*または_allを使用します。
  • <snapshot>
  • (必須、文字列) 取得するスナップショット名のカンマ区切りリスト。ワイルドカード(*)式がサポートされており、-で始まる除外パターンとワイルドカードを組み合わせることができます。
    • 登録されたリポジトリ内のすべてのスナップショットに関する情報を取得するには、ワイルドカード(*)または_allを使用します。
    • 現在実行中のスナップショットに関する情報を取得するには、_currentを使用します。
      リクエストで_allを使用すると、スナップショットが利用できない場合は失敗します。ignore_unavailableをtrueに設定すると、利用可能なスナップショットのみが返されます。

クエリパラメータ

  • master_timeout

  • (オプション、時間単位) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

  • ignore_unavailable
  • (オプション、ブール値) falseの場合、リクエストは利用できないスナップショットに対してエラーを返します。デフォルトはfalseです。
    trueの場合、リクエストは破損しているか、一時的に返すことができないスナップショットを無視します。
  • verbose
  • (オプション、ブール値) trueの場合、スナップショットを取得したElasticsearchのバージョン、スナップショットの開始および終了時刻、スナップショットされたシャードの数など、各スナップショットに関する追加情報を返します。デフォルトはtrueです。falseの場合、追加情報は省略されます。
  • index_names
  • (オプション、ブール値) trueの場合、レスポンス内の各スナップショットに含まれるインデックス名のリストを返します。デフォルトはtrueです。
  • index_details
  • (オプション、ブール値) trueの場合、インデックス内のシャード数、インデックスの合計サイズ（バイト単位）、インデックス内のシャードごとの最大セグメント数を含む各インデックスに関する追加情報を返します。デフォルトはfalseで、この情報は省略されます。
  • include_repository
  • (オプション、ブール値) trueの場合、レスポンス内の各スナップショットに対するリポジトリ名を返します。デフォルトはtrueです。
  • sort
  • (オプション、文字列) 結果のソート順を設定できます。デフォルトはstart_time、すなわちスナップショットの開始タイムスタンプでソートします。 
    1. -   `````start_time
    • スナップショットを開始タイムスタンプでソートし、スナップショット名で同点を解決します。
    • duration
    • スナップショットをその期間でソートし、スナップショット名で同点を解決します。
    • name
    • スナップショットをその名前でソートします。
    • repository
    • スナップショットをそのリポジトリ名でソートし、スナップショット名で同点を解決します。
    • index_count
    • スナップショットを含むインデックスの数でソートし、スナップショット名で同点を解決します。
    • shard_count
    • スナップショットを含むシャードの数でソートし、スナップショット名で同点を解決します。
    • failed_shard_count
    • スナップショットをスナップショットに失敗したシャードの数でソートし、スナップショット名で同点を解決します。
  • size
  • (オプション、整数) 返すスナップショットの最大数。デフォルトは0で、リクエストに一致するすべてを制限なしで返します。
  • order
  • (オプション、文字列) ソート順。ascは昇順、descは降順の有効な値です。デフォルトはascで、昇順を意味します。
  • from_sort_value
  • (オプション、文字列) 取得を開始する現在のソート列の値。スナップショットまたはリポジトリ名でソートする場合は文字列のスナップショット名またはリポジトリ名、インデックスまたはシャード数でソートする場合はミリ秒の時間値または数値である必要があります。
  • after
  • (オプション、文字列) レスポンスボディ内のnextフィールドによって返されたページネーションを開始するためのオフセット識別子。このパラメータの使用は、from_sort_valueパラメータの使用と相互排他的です。
  • offset
  • (オプション、整数) このリクエストに一致するスナップショットに基づいてページネーションを開始するための数値オフセット。このパラメータに非ゼロ値を使用することは、afterパラメータの使用と相互排他的です。デフォルトは0です。
  • slm_policy_filter
  • (オプション、文字列) スナップショットが属するSLMポリシー名のカンマ区切りリストでスナップショットをフィルタリングします。ワイルドカード(\*)や、-で始まる除外パターンとワイルドカードの組み合わせも受け入れます。たとえば、パターン*,-policy-a-\*は、policy-a-で始まる名前のSLMポリシーによって作成されたスナップショットを除外して、すべてのスナップショットを返します。ワイルドカードパターン*は、SLMポリシーによって作成されたすべてのスナップショットに一致しますが、SLMポリシーによって作成されていないスナップショットには一致しません。SLMポリシーによって作成されていないスナップショットを含めるには、_noneという特別なパターンを使用して、SLMポリシーなしのすべてのスナップショットに一致させることができます。
  2. `````size`````、`````order`````、`````after`````、`````from_sort_value`````、`````offset`````、`````slm_policy_filter`````、および`````sort`````のパラメータは、`````verbose=false`````を使用する場合はサポートされておらず、`````verbose=false`````を使用したリクエストのソート順は未定義です。
  5. ## レスポンスボディ
  7. -   `````snapshot
  • (文字列) スナップショットの名前。
  • uuid
  • (文字列) スナップショットのユニバーサルユニーク識別子（UUID）。
  • version_id
  • (整数) スナップショットを作成するために使用されたElasticsearchバージョンのビルドID。
  • version
  • (浮動小数点) スナップショットを作成するために使用されたElasticsearchバージョン。
  • indices
  • (配列) スナップショットに含まれるインデックスのリスト。
  • index_details
  • (オブジェクト) スナップショット内の各インデックスの詳細。インデックス名でキー付けされています。?index_detailsクエリパラメータが設定されている場合のみ存在し、十分に最近のElasticsearchバージョンで完全にスナップショットされたインデックスの詳細のみを含みます。 
    1. -   `````shard_count
    • (整数) このインデックス内のシャード数。
    • size
    • (文字列) このインデックス内のすべてのシャードの合計サイズ。?humanクエリパラメータが設定されている場合のみ存在します。
    • size_in_bytes
    • (長整数) このインデックス内のすべてのシャードの合計サイズ（バイト単位）。
    • max_segments_per_shard
    • (整数) このインデックススナップショット内のシャードごとの最大セグメント数。
  • data_streams
  • (文字列の配列) スナップショットに含まれるdata streamsのリスト。
  • include_global_state

  • (ブール値) 現在のクラスター状態がスナップショットに含まれているかどうかを示します。

  • feature_states
  • (オブジェクトの配列) スナップショット内の機能状態。スナップショットに1つ以上の機能状態が含まれている場合のみ存在します。 
    1. -   `````feature_name
    • (文字列) get features APIによって返される機能の名前。
    • indices
    • (文字列の配列) 機能状態のインデックス。
  • start_time
  • (文字列) スナップショット作成プロセスが開始された日時のタイムスタンプ。
  • start_time_in_millis
  • (長整数) スナップショット作成プロセスが開始されたときの時間（ミリ秒単位）。
  • end_time
  • (文字列) スナップショット作成プロセスが終了した日時のタイムスタンプ。
  • end_time_in_millis
  • (長整数) スナップショット作成プロセスが終了したときの時間（ミリ秒単位）。
  • duration_in_millis

  • (長整数) スナップショットを作成するのにかかった時間（ミリ秒単位）。

  • failures
  • (配列) スナップショット作成時に発生した失敗をリストします。
  • shards

  • (オブジェクト) スナップショット内のシャードの数を含みます。 

    1. -   `````total
    • (整数) スナップショットに含まれるシャードの総数。
    • successful
    • (整数) スナップショットに正常に含まれたシャードの数。
    • failed
    • (整数) スナップショットに含まれなかったシャードの数。

  • state
  • (文字列) スナップショットstateは次のいずれかの値です： 
    1. -   `````IN_PROGRESS
    • スナップショットは現在実行中です。
    • SUCCESS
    • スナップショットが完了し、すべてのシャードが正常に保存されました。
    • FAILED
    • スナップショットがエラーで終了し、データを保存できませんでした。
    • PARTIAL
    • グローバルクラスター状態が保存されましたが、少なくとも1つのシャードのデータが正常に保存されませんでした。レスポンスのfailuresセクションには、正しく処理されなかったシャードに関する詳細情報が含まれています。
  • next
  • (文字列) リクエストにサイズ制限が含まれていて、さらに結果がある可能性がある場合、nextフィールドがレスポンスに追加され、追加の結果を取得するためにafterクエリパラメータとして使用できます。
  • total
  • (整数) サイズ制限またはafterクエリパラメータを無視した場合にリクエストに一致するスナップショットの総数。
  • remaining
  • (整数) サイズ制限のために返されなかった残りのスナップショットの数で、nextフィールド値を使用して追加のリクエストで取得できます。

例

次のリクエストは、snapshot_2リポジトリ内の情報を返します。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="snapshot_2",
  4. )
  5. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: 'snapshot_2'
  4. )
  5. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "snapshot_2",
  4. });
  5. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/snapshot_2

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

コンソール-結果

  1. {
  2.   "snapshots": [
  3.    {
  4.    "snapshot": "snapshot_2",
  5.    "uuid": "vdRctLCxSketdKb54xw67g",
  6.    "repository": "my_repository",
  7.    "version_id": <version_id>,
  8.    "version": <version>,
  9.    "indices": [],
  10.    "data_streams": [],
  11.    "feature_states": [],
  12.    "include_global_state": true,
  13.    "state": "SUCCESS",
  14.    "start_time": "2020-07-06T21:55:18.129Z",
  15.    "start_time_in_millis": 1593093628850,
  16.    "end_time": "2020-07-06T21:55:18.129Z",
  17.    "end_time_in_millis": 1593094752018,
  18.    "duration_in_millis": 0,
  19.    "failures": [],
  20.    "shards": {
  21.    "total": 0,
  22.    "failed": 0,
  23.    "successful": 0
  24.    }
  25.    }
  26.   ],
  27.   "total": 1,
  28.   "remaining": 0
  29. }

次のリクエストは、snapshotプレフィックスを持つすべてのスナップショットに関する情報をmy_repositoryリポジトリ内で返し、レスポンスサイズを2に制限し、スナップショット名でソートします。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="snapshot*",
  4.    size="2",
  5.    sort="name",
  6. )
  7. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: 'snapshot*',
  4.   size: 2,
  5.   sort: 'name'
  6. )
  7. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "snapshot*",
  4.   size: 2,
  5.   sort: "name",
  6. });
  7. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/snapshot*?size=2&sort=name

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

コンソール-結果

  1. {
  2.   "snapshots": [
  3.    {
  4.    "snapshot": "snapshot_1",
  5.    "uuid": "dKb54xw67gvdRctLCxSket",
  6.    "repository": "my_repository",
  7.    "version_id": <version_id>,
  8.    "version": <version>,
  9.    "indices": [],
  10.    "data_streams": [],
  11.    "feature_states": [],
  12.    "include_global_state": true,
  13.    "state": "SUCCESS",
  14.    "start_time": "2020-07-06T21:55:18.129Z",
  15.    "start_time_in_millis": 1593093628850,
  16.    "end_time": "2020-07-06T21:55:18.129Z",
  17.    "end_time_in_millis": 1593094752018,
  18.    "duration_in_millis": 0,
  19.    "failures": [],
  20.    "shards": {
  21.    "total": 0,
  22.    "failed": 0,
  23.    "successful": 0
  24.    }
  25.    },
  26.    {
  27.    "snapshot": "snapshot_2",
  28.    "uuid": "vdRctLCxSketdKb54xw67g",
  29.    "repository": "my_repository",
  30.    "version_id": <version_id>,
  31.    "version": <version>,
  32.    "indices": [],
  33.    "data_streams": [],
  34.    "feature_states": [],
  35.    "include_global_state": true,
  36.    "state": "SUCCESS",
  37.    "start_time": "2020-07-06T21:55:18.130Z",
  38.    "start_time_in_millis": 1593093628851,
  39.    "end_time": "2020-07-06T21:55:18.130Z",
  40.    "end_time_in_millis": 1593094752019,
  41.    "duration_in_millis": 1,
  42.    "failures": [],
  43.    "shards": {
  44.    "total": 0,
  45.    "failed": 0,
  46.    "successful": 0
  47.    }
  48.    }
  49.   ],
  50.   "next": "c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=",
  51.   "total": 3,
  52.   "remaining": 1
  53. }

その後のリクエストは、前のレスポンスからnext値をafterパラメータとして使用して残りのスナップショットを取得できます。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="snapshot*",
  4.    size="2",
  5.    sort="name",
  6.    after="c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=",
  7. )
  8. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: 'snapshot*',
  4.   size: 2,
  5.   sort: 'name',
  6.   after: 'c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI='
  7. )
  8. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "snapshot*",
  4.   size: 2,
  5.   sort: "name",
  6.   after: "c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=",
  7. });
  8. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/snapshot*?size=2&sort=name&after=c25hcHNob3RfMixteV9yZXBvc2l0b3J5LHNuYXBzaG90XzI=

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

コンソール-結果

  1. {
  2.   "snapshots": [
  3.    {
  4.    "snapshot": "snapshot_3",
  5.    "uuid": "dRctdKb54xw67gvLCxSket",
  6.    "repository": "my_repository",
  7.    "version_id": <version_id>,
  8.    "version": <version>,
  9.    "indices": [],
  10.    "data_streams": [],
  11.    "feature_states": [],
  12.    "include_global_state": true,
  13.    "state": "SUCCESS",
  14.    "start_time": "2020-07-06T21:55:18.129Z",
  15.    "start_time_in_millis": 1593093628850,
  16.    "end_time": "2020-07-06T21:55:18.129Z",
  17.    "end_time_in_millis": 1593094752018,
  18.    "duration_in_millis": 0,
  19.    "failures": [],
  20.    "shards": {
  21.    "total": 0,
  22.    "failed": 0,
  23.    "successful": 0
  24.    }
  25.    }
  26.   ],
  27.   "total": 3,
  28.   "remaining": 0
  29. }

また、2のオフセット値を使用して、すでに見た2つのスナップショットをスキップすることで同じ結果を取得できます。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="snapshot*",
  4.    size="2",
  5.    sort="name",
  6.    offset="2",
  7. )
  8. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: 'snapshot*',
  4.   size: 2,
  5.   sort: 'name',
  6.   offset: 2
  7. )
  8. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "snapshot*",
  4.   size: 2,
  5.   sort: "name",
  6.   offset: 2,
  7. });
  8. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/snapshot*?size=2&sort=name&offset=2

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

コンソール-結果

  1. {
  2.   "snapshots": [
  3.    {
  4.    "snapshot": "snapshot_3",
  5.    "uuid": "dRctdKb54xw67gvLCxSket",
  6.    "repository": "my_repository",
  7.    "version_id": <version_id>,
  8.    "version": <version>,
  9.    "indices": [],
  10.    "data_streams": [],
  11.    "feature_states": [],
  12.    "include_global_state": true,
  13.    "state": "SUCCESS",
  14.    "start_time": "2020-07-06T21:55:18.129Z",
  15.    "start_time_in_millis": 1593093628850,
  16.    "end_time": "2020-07-06T21:55:18.129Z",
  17.    "end_time_in_millis": 1593094752018,
  18.    "duration_in_millis": 0,
  19.    "failures": [],
  20.    "shards": {
  21.    "total": 0,
  22.    "failed": 0,
  23.    "successful": 0
  24.    }
  25.    }
  26.   ],
  27.   "total": 3,
  28.   "remaining": 0
  29. }

次のリクエストは、snapshotプレフィックスを持つすべてのスナップショットに関する情報をmy_repositoryリポジトリ内で返し、snapshot_3という名前のスナップショットを除外します。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="snapshot*,-snapshot_3",
  4.    sort="name",
  5. )
  6. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: 'snapshot*,-snapshot_3',
  4.   sort: 'name'
  5. )
  6. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "snapshot*,-snapshot_3",
  4.   sort: "name",
  5. });
  6. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/snapshot*,-snapshot_3?sort=name

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

コンソール-結果

  1. {
  2.   "snapshots": [
  3.    {
  4.    "snapshot": "snapshot_1",
  5.    "uuid": "dKb54xw67gvdRctLCxSket",
  6.    "repository": "my_repository",
  7.    "version_id": <version_id>,
  8.    "version": <version>,
  9.    "indices": [],
  10.    "data_streams": [],
  11.    "feature_states": [],
  12.    "include_global_state": true,
  13.    "state": "SUCCESS",
  14.    "start_time": "2020-07-06T21:55:18.129Z",
  15.    "start_time_in_millis": 1593093628850,
  16.    "end_time": "2020-07-06T21:55:18.129Z",
  17.    "end_time_in_millis": 1593094752018,
  18.    "duration_in_millis": 0,
  19.    "failures": [],
  20.    "shards": {
  21.    "total": 0,
  22.    "failed": 0,
  23.    "successful": 0
  24.    }
  25.    },
  26.    {
  27.    "snapshot": "snapshot_2",
  28.    "uuid": "vdRctLCxSketdKb54xw67g",
  29.    "repository": "my_repository",
  30.    "version_id": <version_id>,
  31.    "version": <version>,
  32.    "indices": [],
  33.    "data_streams": [],
  34.    "feature_states": [],
  35.    "include_global_state": true,
  36.    "state": "SUCCESS",
  37.    "start_time": "2020-07-06T21:55:18.130Z",
  38.    "start_time_in_millis": 1593093628851,
  39.    "end_time": "2020-07-06T21:55:18.130Z",
  40.    "end_time_in_millis": 1593094752019,
  41.    "duration_in_millis": 1,
  42.    "failures": [],
  43.    "shards": {
  44.    "total": 0,
  45.    "failed": 0,
  46.    "successful": 0
  47.    }
  48.    }
  49.   ],
  50.   "total": 2,
  51.   "remaining": 0
  52. }

次のリクエストは、デフォルトの昇順でスナップショット名でソートした場合、snapshot_2の後に続くすべてのスナップショットに関する情報を返します。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="*",
  4.    sort="name",
  5.    from_sort_value="snapshot_2",
  6. )
  7. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: '*',
  4.   sort: 'name',
  5.   from_sort_value: 'snapshot_2'
  6. )
  7. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "*",
  4.   sort: "name",
  5.   from_sort_value: "snapshot_2",
  6. });
  7. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/*?sort=name&from_sort_value=snapshot_2

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

コンソール-結果

  1. {
  2.   "snapshots": [
  3.    {
  4.    "snapshot": "snapshot_2",
  5.    "uuid": "vdRctLCxSketdKb54xw67g",
  6.    "repository": "my_repository",
  7.    "version_id": <version_id>,
  8.    "version": <version>,
  9.    "indices": [],
  10.    "data_streams": [],
  11.    "feature_states": [],
  12.    "include_global_state": true,
  13.    "state": "SUCCESS",
  14.    "start_time": "2020-07-06T21:55:18.130Z",
  15.    "start_time_in_millis": 1593093628851,
  16.    "end_time": "2020-07-06T21:55:18.130Z",
  17.    "end_time_in_millis": 1593094752019,
  18.    "duration_in_millis": 1,
  19.    "failures": [],
  20.    "shards": {
  21.    "total": 0,
  22.    "failed": 0,
  23.    "successful": 0
  24.    }
  25.    },
  26.    {
  27.    "snapshot": "snapshot_3",
  28.    "uuid": "dRctdKb54xw67gvLCxSket",
  29.    "repository": "my_repository",
  30.    "version_id": <version_id>,
  31.    "version": <version>,
  32.    "indices": [],
  33.    "data_streams": [],
  34.    "feature_states": [],
  35.    "include_global_state": true,
  36.    "state": "SUCCESS",
  37.    "start_time": "2020-07-06T21:55:18.129Z",
  38.    "start_time_in_millis": 1593093628850,
  39.    "end_time": "2020-07-06T21:55:18.129Z",
  40.    "end_time_in_millis": 1593094752018,
  41.    "duration_in_millis": 0,
  42.    "failures": [],
  43.    "shards": {
  44.    "total": 0,
  45.    "failed": 0,
  46.    "successful": 0
  47.    }
  48.    }
  49.   ],
  50.   "total": 2,
  51.   "remaining": 0
  52. }

次のリクエストは、snapshot_で始まる名前のすべてのスナップショットに関する情報を返し、1577833200000のタイムスタンプ（2020年1月1日）以降に開始されたものをデフォルトの昇順でスナップショット開始時間でソートします。

Python

  1. resp = client.snapshot.get(
  2.    repository="my_repository",
  3.    snapshot="snapshot_*",
  4.    sort="start_time",
  5.    from_sort_value="1577833200000",
  6. )
  7. print(resp)

Ruby

  1. response = client.snapshot.get(
  2.   repository: 'my_repository',
  3.   snapshot: 'snapshot_*',
  4.   sort: 'start_time',
  5.   from_sort_value: 1_577_833_200_000
  6. )
  7. puts response

Js

  1. const response = await client.snapshot.get({
  2.   repository: "my_repository",
  3.   snapshot: "snapshot_*",
  4.   sort: "start_time",
  5.   from_sort_value: 1577833200000,
  6. });
  7. console.log(response);

コンソール

  1. GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000

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

コンソール-結果

  1. {
  2.   "snapshots": [
  3.    {
  4.    "snapshot": "snapshot_1",
  5.    "uuid": "dKb54xw67gvdRctLCxSket",
  6.    "repository": "my_repository",
  7.    "version_id": <version_id>,
  8.    "version": <version>,
  9.    "indices": [],
  10.    "data_streams": [],
  11.    "feature_states": [],
  12.    "include_global_state": true,
  13.    "state": "SUCCESS",
  14.    "start_time": "2020-07-06T21:55:18.128Z",
  15.    "start_time_in_millis": 1593093628849,
  16.    "end_time": "2020-07-06T21:55:18.129Z",
  17.    "end_time_in_millis": 1593093628850,
  18.    "duration_in_millis": 1,
  19.    "failures": [],
  20.    "shards": {
  21.    "total": 0,
  22.    "failed": 0,
  23.    "successful": 0
  24.    }
  25.    },
  26.    {
  27.    "snapshot": "snapshot_2",
  28.    "uuid": "vdRctLCxSketdKb54xw67g",
  29.    "repository": "my_repository",
  30.    "version_id": <version_id>,
  31.    "version": <version>,
  32.    "indices": [],
  33.    "data_streams": [],
  34.    "feature_states": [],
  35.    "include_global_state": true,
  36.    "state": "SUCCESS",
  37.    "start_time": "2020-07-06T21:55:18.130Z",
  38.    "start_time_in_millis": 1593093628851,
  39.    "end_time": "2020-07-06T21:55:18.130Z",
  40.    "end_time_in_millis": 1593093628851,
  41.    "duration_in_millis": 0,
  42.    "failures": [],
  43.    "shards": {
  44.    "total": 0,
  45.    "failed": 0,
  46.    "successful": 0
  47.    }
  48.    },
  49.    {
  50.    "snapshot": "snapshot_3",
  51.    "uuid": "dRctdKb54xw67gvLCxSket",
  52.    "repository": "my_repository",
  53.    "version_id": <version_id>,
  54.    "version": <version>,
  55.    "indices": [],
  56.    "data_streams": [],
  57.    "feature_states": [],
  58.    "include_global_state": true,
  59.    "state": "SUCCESS",
  60.    "start_time": "2020-07-06T21:55:18.131Z",
  61.    "start_time_in_millis": 1593093628852,
  62.    "end_time": "2020-07-06T21:55:18.135Z",
  63.    "end_time_in_millis": 1593093628856,
  64.    "duration_in_millis": 4,
  65.    "failures": [],
  66.    "shards": {
  67.    "total": 0,
  68.    "failed": 0,
  69.    "successful": 0
  70.    }
  71.    }
  72.   ],
  73.   "total": 3,
  74.   "remaining": 0
  75. }