This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« ES|QL async query API ES|QL async query delete API »

› › ›

ES|QL async query get API

edit

ES|QL async query get API

edit

Returns the current status and available results for an ES|QL async query or a stored results.

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

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

const response = await client.transport.request({
  method: "GET",
  path: "/_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM&#x3D;",
});
console.log(response);

GET /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

Request

edit

GET /_query/async/<query_id>

Prerequisites

edit

If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.

Path parameters

edit

<query_id>

(Required, string) Identifier for the query.

A query ID is provided in the ES|QL async query API's response for a query that does not complete in the awaited time. A query ID is also provided if the request’s keep_on_completion parameter is true.

Query parameters

edit

The API accepts the same parameters as the synchronous query API, along with the following parameters:

wait_for_completion_timeout

(Optional, time value) Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete query results.

If this parameter is specified and the request completes during this period, complete query results are returned.

If the request does not complete during this period, the response returns an is_running value of true and no results.

Response body

edit

The ES|QL async query get API returns the same response body as the ES|QL query API. See the ES|QL query API’s response body parameters.

« ES|QL async query API ES|QL async query delete API »