Returns the current status of an async SQL search or a stored synchronous SQL search.
GET _sql/async/status/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=?format=json
-
If the Elasticsearch security features are enabled, you must have the
monitorcluster privilege to use this API.
See SQL Limitations.
-
id - (string) Identifier for the search.
-
is_running -
(Boolean) If
true, the search is still running. Iffalse, the search has finished. -
is_partial -
(Boolean) If
true, the response does not contain complete search results. Ifis_partialistrueandis_runningistrue, the search is still running. Ifis_partialistruebutis_runningisfalse, the results are partial due to a failure or timeout. -
start_time_in_millis - (integer) Timestamp, in milliseconds since the Unix epoch, when the search started. The API only returns this property for running searches.
-
expiration_time_in_millis - (integer) Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.
-
completion_status - (integer) HTTP status code for the search. The API only returns this property for completed searches.