グローバルチェックポイントAPIの取得

get global checkpoints APIの目的は、インデックスの現在のグローバルチェックポイントを返すことです。このAPIは、ユーザーがElasticsearchに安全に永続化されたシーケンス番号を知ることを可能にします。

グローバルチェックポイントの進行状況のポーリング

このAPIには、wait_for_advanceクエリパラメータによって有効にされるオプションのポーリングモードがあります。ポーリングモードでは、APIは提供されたcheckpointsを超えてグローバルチェックポイントが進行するまで返されません。デフォルトでは、checkpointsは空の配列であり、これによりAPIは即座に返されます。

提供されたcheckpointsを超えてグローバルチェックポイントが進行する前にタイムアウトが発生した場合、Elasticsearchは現在のグローバルチェックポイントとリクエストがタイムアウトしたことを示すブール値を返します。

現在、wait_for_advanceパラメータは1つのシャードインデックスのみサポートされています。

インデックス準備のポーリング

デフォルトでは、ポーリングモードでインデックスが存在しないか、すべてのプライマリシャードがアクティブでない場合、例外が返されます。ポーリングモードでは、wait_for_indexパラメータを使用してこの動作を変更できます。wait_for_indexがtrueに設定されている場合、APIはインデックスが作成され、すべてのプライマリシャードがアクティブになるのを待ちます。

これらの条件が満たされる前にタイムアウトが発生した場合、関連する例外が返されます。

現在、wait_for_indexパラメータはwait_for_advanceがtrueのときのみサポートされています。

リクエスト

GET /<index>/_fleet/global_checkpoints

パスパラメータ

  • <index>
  • (必須、文字列) 単一のインデックスまたは単一のインデックスに解決されるインデックスエイリアス。

クエリパラメータ

  • wait_for_advance
  • (オプション、ブール値) 提供されたcheckpointsを超えてグローバルチェックポイントが進行するのを待つかどうかを制御するブール値。デフォルトはfalseです。
  • wait_for_index
  • (オプション、ブール値) ターゲットインデックスが存在し、すべてのプライマリシャードがアクティブになるのを待つかどうかを制御するブール値。wait_for_advanceがtrueのときのみtrueにできます。デフォルトはfalseです。
  • checkpoints
  • (オプション、リスト) 前のグローバルチェックポイントのカンマ区切りリスト。wait_for_advanceと組み合わせて使用されると、APIはグローバルチェックポイントがcheckpointsを超えて進行するまで返されません。デフォルトは空のリストであり、これによりElasticsearchは現在のグローバルチェックポイントを即座に返します。
  • timeout
  • (オプション、時間単位) グローバルチェックポイントがcheckpointsを超えて進行するのを待つ期間。デフォルトは30sです。

レスポンスボディ

  • global_checkpoints
  • (整数の配列) インデックスのグローバルチェックポイント。
  • timed_out
  • (ブール値) falseグローバルチェックポイントが指定されたcheckpointsを超えて進行しなかった場合、指定されたtimeout内。