Get async SQL search status API
editGet async SQL search status API
editReturns the current status of an async SQL search or a stored synchronous SQL search.
resp = client.sql.get_async_status( id="FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=", format="json", ) print(resp)
response = client.sql.get_async_status( id: 'FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=', format: 'json' ) puts response
const response = await client.sql.getAsyncStatus({ id: "FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=", format: "json", }); console.log(response);
GET _sql/async/status/FmdMX2pIang3UWhLRU5QS0lqdlppYncaMUpYQ05oSkpTc3kwZ21EdC1tbFJXQToxOTI=?format=json
Request
editGET _sql/async/status/<search_id>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor
cluster privilege to use this API.
Limitations
editSee SQL Limitations.
Path parameters
edit-
<search_id>
- (Required, string) Identifier for the search.
Response body
edit-
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_partial
istrue
andis_running
istrue
, the search is still running. Ifis_partial
istrue
butis_running
isfalse
, 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.