ES|QL非同期クエリ取得API（ES|QL async query get API）

ES|QL 非同期クエリ取得 API

現在のステータスと、ES|QL 非同期クエリまたは保存された結果の利用可能な結果を返します。

Python

resp = client.esql.async_query_get(
   id="FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
   body=None,
)
print(resp)

Ruby

response = client.esql.async_query_get(
  id: 'FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM='
)
puts response

Js

const response = await client.esql.asyncQueryGet({
  id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
  body: null,
});
console.log(response);

Console

GET /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

Request

GET /_query/async/<query_id>

Prerequisites

• Elasticsearchのセキュリティ機能が有効になっている場合、最初にES|QLクエリを送信したユーザーのみがこのAPIを使用して結果を取得できます。

Path parameters

• <query_id>
• (必須、文字列) クエリの識別子。
  クエリが期待された時間内に完了しない場合、ES|QL 非同期クエリ API
  の応答にクエリ IDが提供されます。リクエストのkeep_on_completionパラメータがtrueの場合も、クエリ IDが提供されます。

Query parameters

• wait_for_completion_timeout
• (オプション、時間値) リクエストが完了するまでのタイムアウト期間。デフォルトではタイムアウトなし、つまりリクエストは完全なクエリ結果を待ちます。
  このパラメータが指定され、リクエストがこの期間内に完了した場合、完全なクエリ結果が返されます。
  この期間内にリクエストが完了しない場合、応答はis_runningの値trueを返し、結果はありません。

Response body

ES|QL 非同期クエリ取得 APIは、ES|QLクエリ APIと同じ応答ボディを返します。ES|QLクエリ APIの応答ボディパラメータを参照してください。