Get the async search status

GET /_async_search/status/{id}

Auth

Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:

The user or API key that submitted the original async search request.
Users that have the monitor cluster privilege or greater privileges.

Required privileges

Cluster privileges monitor

Path parameters

id string required: A unique identifier for the async search.

Query parameters

keep_alive union oneOf · default: 5d: The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.; Values: -1 0

Response

application/json

id string
is_partial boolean required: When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running, is_partial is always set to true.
is_running boolean required: Indicates whether the search is still running or has completed.

Note

If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false.
expiration_time union oneOf: Indicates when the async search will expire.; One of: string or number
expiration_time_in_millis number required
start_time union oneOf: One of: string or number
start_time_in_millis number required
completion_time union oneOf: Indicates when the async search completed. It is present only when the search has completed.; One of: string or number
completion_time_in_millis number
error object
_shards object required: The number of shards that have run the query so far.
_clusters object: Metadata about clusters involved in the cross-cluster search. It is not shown for local-only searches.
completion_status number: If the async search completed, this field shows the status code of the search. For example, 200 indicates that the async search was successfully completed. 503 indicates that the async search was completed with an error.