Get async ES|QL query results Added in 8.13.0
Get the current status and available results or stored results for an ES|QL asynchronous query. 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
-
The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the
keep_on_completion
parameter set totrue
.
Query parameters
-
drop_null_columns boolean
Indicates whether columns that are entirely
null
will be removed from thecolumns
andvalues
portion of the results. Iftrue
, the response will include an extra section under the nameall_columns
which has the name of all the columns. -
keep_alive string
The period for which the query and its results are stored in the cluster. When this period expires, the query and its results are deleted, even if the query is still ongoing.
-
wait_for_completion_timeout string
The period to wait for the request to finish. By default, the request waits for complete query results. If the request completes during the period specified in this parameter, complete query results are returned. Otherwise, the response returns an
is_running
value oftrue
and no results.
curl \
-X GET http://api.example.com/_query/async/{id}
{
"columns": {},
"is_running": true
}