インデックス回復API

1つ以上のインデックスの進行中および完了したシャード回復に関する情報を返します。データストリームの場合、APIはストリームのバックインデックスに関する情報を返します。

Python

  1. resp = client.indices.recovery(
  2.    index="my-index-000001",
  3. )
  4. print(resp)

Ruby

  1. response = client.indices.recovery(
  2.   index: 'my-index-000001'
  3. )
  4. puts response

Js

  1. const response = await client.indices.recovery({
  2.   index: "my-index-000001",
  3. });
  4. console.log(response);

コンソール

  1. GET /my-index-000001/_recovery

リクエスト

GET /<target>/_recovery

GET /_recovery

前提条件

  • Elasticsearchのセキュリティ機能が有効になっている場合、ターゲットデータストリーム、インデックス、またはエイリアスに対してmonitorまたはmanage インデックス権限を持っている必要があります。

説明

インデックス回復APIを使用して、進行中および完了したシャード回復に関する情報を取得します。

シャード回復は、スナップショットからプライマリシャードを復元したり、プライマリシャードからレプリカシャードを作成したりするなど、シャードコピーを初期化するプロセスです。シャード回復が完了すると、回復されたシャードは検索およびインデックス作成に利用可能になります。

回復は次のプロセス中に自動的に発生します：

  • インデックスを初めて作成する時。
  • ノードがクラスターに再参加し、データパスに保持しているデータを使用して欠落しているプライマリシャードコピーを起動する時。
  • プライマリから新しいレプリカシャードコピーを作成する時。
  • 同じクラスター内の別のノードにシャードコピーを移動する時。
  • スナップショットの復元操作。
  • クローン、縮小、または分割操作。

回復またはcat recovery APIを使用して、シャード回復の原因を特定できます。

インデックス回復APIは、クラスター内に現在存在するシャードコピーの完了した回復に関する情報のみを報告します。各シャードコピーの最後の回復のみを報告し、以前の回復に関する履歴情報や、もはや存在しないシャードコピーの回復に関する情報は報告しません。これは、シャードコピーが回復を完了し、その後Elasticsearchがそれを別のノードに移動した場合、元の回復に関する情報は回復APIに表示されないことを意味します。

パスパラメータ

  • <target>
  • （オプション、文字列）リクエストを制限するために使用されるデータストリーム、インデックス、およびエイリアスのカンマ区切りリスト。ワイルドカード（*）をサポートします。すべてのデータストリームとインデックスを対象とするには、このパラメータを省略するか、*または_allを使用します。

クエリパラメータ

  • active_only
  • （オプション、Boolean）trueの場合、応答には進行中のシャード回復のみが含まれます。デフォルトはfalseです。
  • detailed
  • （オプション、Boolean）trueの場合、応答にはシャード回復に関する詳細情報が含まれます。デフォルトはfalseです。
  • index
  • （オプション、文字列）リクエストを制限するために使用されるインデックス名のカンマ区切りリストまたはワイルドカード式。

レスポンスボディ

  • id
  • （整数）シャードのID。
  • type
  • （文字列）シャードの回復元。返される値には次のものが含まれます：
    • EMPTY_STORE
    • 空のストア。新しいプライマリシャードまたはクラスター再ルートAPIを使用して空のプライマリシャードを強制的に割り当てたことを示します。
    • EXISTING_STORE
    • 既存のプライマリシャードのストア。ノードの起動または既存のプライマリシャードの割り当てに関連する回復を示します。
    • LOCAL_SHARDS
    • 同じノード上の別のインデックスのシャード。クローン($9dc5caa6974383a9.md)、縮小($b71a275dcf175740.md)、または分割($2df8972352f7ef9a.md)操作に関連する回復を示します。
    • PEER
    • 別のノード上のプライマリシャード。シャードのレプリケーションに関連する回復を示します。
    • SNAPSHOT
    • スナップショット。スナップショット復元($35f6ad3a9c34a128.md)操作に関連する回復を示します。
  • STAGE
  • （文字列）回復ステージ。返される値には次のものが含まれます：
    • INIT
    • 回復が開始されていません。
    • INDEX
    • インデックスメタデータを読み取り、ソースから宛先にバイトをコピーしています。
    • VERIFY_INDEX
    • インデックスの整合性を検証しています。
    • TRANSLOG
    • トランザクションログを再生しています。
    • FINALIZE
    • クリーンアップ。
    • DONE
    • 完了。
  • primary
  • （Boolean）trueの場合、シャードはプライマリシャードです。
  • start_time
  • （文字列）回復開始のタイムスタンプ。
  • stop_time
  • （文字列）回復終了のタイムスタンプ。
  • total_time_in_millis
  • （文字列）シャードを回復するのにかかった合計時間（ミリ秒）。
  • source
  • （オブジェクト）回復元。これには次のものが含まれる場合があります：
    • スナップショットからの回復の場合のリポジトリの説明
    • ソースノードの説明
  • target
  • （オブジェクト）宛先ノード。
  • index
  • （オブジェクト）物理インデックス回復に関する統計。
  • translog
  • （オブジェクト）トランスログ回復に関する統計。
  • start
  • （オブジェクト）インデックスを開いて開始するのにかかった時間に関する統計。

例

複数のデータストリームとインデックスの回復情報を取得

Python

  1. resp = client.indices.recovery(
  2.    index="index1,index2",
  3.    human=True,
  4. )
  5. print(resp)

Ruby

  1. response = client.indices.recovery(
  2.   index: 'index1,index2',
  3.   human: true
  4. )
  5. puts response

Js

  1. const response = await client.indices.recovery({
  2.   index: "index1,index2",
  3.   human: "true",
  4. });
  5. console.log(response);

コンソール

  1. GET index1,index2/_recovery?human

クラスター内のすべてのデータストリームとインデックスのセグメント情報を取得

Python

  1. resp = client.indices.recovery(
  2.    human=True,
  3. )
  4. print(resp)

Ruby

  1. response = client.indices.recovery(
  2.   human: true
  3. )
  4. puts response

Js

  1. const response = await client.indices.recovery({
  2.   human: "true",
  3. });
  4. console.log(response);

コンソール

  1. GET /_recovery?human

APIは次の応答を返します：

コンソール-結果

  1. {
  2.   "index1" : {
  3.    "shards" : [ {
  4.    "id" : 0,
  5.    "type" : "SNAPSHOT",
  6.    "stage" : "INDEX",
  7.    "primary" : true,
  8.    "start_time" : "2014-02-24T12:15:59.716",
  9.    "start_time_in_millis": 1393244159716,
  10.    "stop_time" : "0s",
  11.    "stop_time_in_millis" : 0,
  12.    "total_time" : "2.9m",
  13.    "total_time_in_millis" : 175576,
  14.    "source" : {
  15.    "repository" : "my_repository",
  16.    "snapshot" : "my_snapshot",
  17.    "index" : "index1",
  18.    "version" : "{version}",
  19.    "restoreUUID": "PDh1ZAOaRbiGIVtCvZOMww"
  20.    },
  21.    "target" : {
  22.    "id" : "ryqJ5lO5S4-lSFbGntkEkg",
  23.    "host" : "my.fqdn",
  24.    "transport_address" : "my.fqdn",
  25.    "ip" : "10.0.1.7",
  26.    "name" : "my_es_node"
  27.    },
  28.    "index" : {
  29.    "size" : {
  30.    "total" : "75.4mb",
  31.    "total_in_bytes" : 79063092,
  32.    "reused" : "0b",
  33.    "reused_in_bytes" : 0,
  34.    "recovered" : "65.7mb",
  35.    "recovered_in_bytes" : 68891939,
  36.    "recovered_from_snapshot" : "0b",
  37.    "recovered_from_snapshot_in_bytes" : 0,
  38.    "percent" : "87.1%"
  39.    },
  40.    "files" : {
  41.    "total" : 73,
  42.    "reused" : 0,
  43.    "recovered" : 69,
  44.    "percent" : "94.5%"
  45.    },
  46.    "total_time" : "0s",
  47.    "total_time_in_millis" : 0,
  48.    "source_throttle_time" : "0s",
  49.    "source_throttle_time_in_millis" : 0,
  50.    "target_throttle_time" : "0s",
  51.    "target_throttle_time_in_millis" : 0
  52.    },
  53.    "translog" : {
  54.    "recovered" : 0,
  55.    "total" : 0,
  56.    "percent" : "100.0%",
  57.    "total_on_start" : 0,
  58.    "total_time" : "0s",
  59.    "total_time_in_millis" : 0
  60.    },
  61.    "verify_index" : {
  62.    "check_index_time" : "0s",
  63.    "check_index_time_in_millis" : 0,
  64.    "total_time" : "0s",
  65.    "total_time_in_millis" : 0
  66.    }
  67.    } ]
  68.   }
  69. }

この応答には、単一のインデックスが単一のシャードを回復している情報が含まれています。回復のソースはスナップショットリポジトリであり、回復のターゲットはmy_es_nodeノードです。

応答には、回復されたファイルとバイトの数と割合も含まれています。

詳細な回復情報を取得

回復中の物理ファイルのリストを取得するには、detailedクエリパラメータをtrueに設定します。

Python

  1. resp = client.indices.recovery(
  2.    human=True,
  3.    detailed=True,
  4. )
  5. print(resp)

Ruby

  1. response = client.indices.recovery(
  2.   human: true,
  3.   detailed: true
  4. )
  5. puts response

Js

  1. const response = await client.indices.recovery({
  2.   human: "true",
  3.   detailed: "true",
  4. });
  5. console.log(response);

コンソール

  1. GET _recovery?human&detailed=true

APIは次の応答を返します：

コンソール-結果

  1. {
  2.   "index1" : {
  3.    "shards" : [ {
  4.    "id" : 0,
  5.    "type" : "EXISTING_STORE",
  6.    "stage" : "DONE",
  7.    "primary" : true,
  8.    "start_time" : "2014-02-24T12:38:06.349",
  9.    "start_time_in_millis" : "1393245486349",
  10.    "stop_time" : "2014-02-24T12:38:08.464",
  11.    "stop_time_in_millis" : "1393245488464",
  12.    "total_time" : "2.1s",
  13.    "total_time_in_millis" : 2115,
  14.    "source" : {
  15.    "id" : "RGMdRc-yQWWKIBM4DGvwqQ",
  16.    "host" : "my.fqdn",
  17.    "transport_address" : "my.fqdn",
  18.    "ip" : "10.0.1.7",
  19.    "name" : "my_es_node"
  20.    },
  21.    "target" : {
  22.    "id" : "RGMdRc-yQWWKIBM4DGvwqQ",
  23.    "host" : "my.fqdn",
  24.    "transport_address" : "my.fqdn",
  25.    "ip" : "10.0.1.7",
  26.    "name" : "my_es_node"
  27.    },
  28.    "index" : {
  29.    "size" : {
  30.    "total" : "24.7mb",
  31.    "total_in_bytes" : 26001617,
  32.    "reused" : "24.7mb",
  33.    "reused_in_bytes" : 26001617,
  34.    "recovered" : "0b",
  35.    "recovered_in_bytes" : 0,
  36.    "recovered_from_snapshot" : "0b",
  37.    "recovered_from_snapshot_in_bytes" : 0,
  38.    "percent" : "100.0%"
  39.    },
  40.    "files" : {
  41.    "total" : 26,
  42.    "reused" : 26,
  43.    "recovered" : 0,
  44.    "percent" : "100.0%",
  45.    "details" : [ {
  46.    "name" : "segments.gen",
  47.    "length" : 20,
  48.    "recovered" : 20
  49.    }, {
  50.    "name" : "_0.cfs",
  51.    "length" : 135306,
  52.    "recovered" : 135306,
  53.    "recovered_from_snapshot": 0
  54.    }, {
  55.    "name" : "segments_2",
  56.    "length" : 251,
  57.    "recovered" : 251,
  58.    "recovered_from_snapshot": 0
  59.    }
  60.    ]
  61.    },
  62.    "total_time" : "2ms",
  63.    "total_time_in_millis" : 2,
  64.    "source_throttle_time" : "0s",
  65.    "source_throttle_time_in_millis" : 0,
  66.    "target_throttle_time" : "0s",
  67.    "target_throttle_time_in_millis" : 0
  68.    },
  69.    "translog" : {
  70.    "recovered" : 71,
  71.    "total" : 0,
  72.    "percent" : "100.0%",
  73.    "total_on_start" : 0,
  74.    "total_time" : "2.0s",
  75.    "total_time_in_millis" : 2025
  76.    },
  77.    "verify_index" : {
  78.    "check_index_time" : 0,
  79.    "check_index_time_in_millis" : 0,
  80.    "total_time" : "88ms",
  81.    "total_time_in_millis" : 88
  82.    }
  83.    } ]
  84.   }
  85. }

応答には、回復された物理ファイルとそのサイズのリストが含まれています。

応答には、回復のさまざまな段階のミリ秒単位のタイミングも含まれています：

  • インデックス取得
  • トランスログ再生
  • インデックス開始時間

この応答は、回復がdoneであることを示しています。進行中または完了したすべての回復はクラスター状態に保持され、いつでも報告される可能性があります。

進行中の回復に関する情報のみを返すには、active_onlyクエリパラメータをtrueに設定します。