非同期 SQL 検索ステータス API

現在の 非同期 SQL 検索 または 保存された同期 SQL 検索 のステータスを返します。

Python

  1. resp = client.sql.get_async_status(
  2.    id="FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=",
  3.    format="json",
  4. )
  5. print(resp)

Ruby

  1. response = client.sql.get_async_status(
  2.   id: 'FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=',
  3.   format: 'json'
  4. )
  5. puts response

Js

  1. const response = await client.sql.getAsyncStatus({
  2.   id: "FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=",
  3.   format: "json",
  4. });
  5. console.log(response);

コンソール

  1. GET _sql/async/status/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=?format=json

リクエスト

GET _sql/async/status/<search_id>

前提条件

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

制限事項

詳細は SQL 制限事項 を参照してください。

パスパラメータ

  • <search_id>
  • (必須、文字列) 検索の識別子。

レスポンスボディ

  • id
  • (文字列) 検索の識別子。
  • is_running
  • (ブール値) true の場合、検索はまだ実行中です。false の場合、検索は完了しています。
  • is_partial
  • (ブール値) true の場合、レスポンスには完全な検索結果が含まれていません。is_partial が true で、is_running が true の場合、検索はまだ実行中です。is_partial が true ですが、is_running が false の場合、結果は失敗またはタイムアウトのため部分的です。
  • start_time_in_millis
  • (整数) 検索が開始された時刻のタイムスタンプ（Unix エポックからのミリ秒）。API は実行中の検索に対してのみこのプロパティを返します。
  • expiration_time_in_millis
  • (整数) Elasticsearch が検索とその結果を削除する時刻のタイムスタンプ（Unix エポックからのミリ秒）。検索がまだ実行中であっても、これが適用されます。
  • completion_status
  • (整数) 検索の HTTP ステータスコード。API は完了した検索に対してのみこのプロパティを返します。