Get the async SQL search status

GET /_sql/async/status/{id}

Auth

Get the current status of an async SQL search or a stored synchronous SQL search.

Required privileges

Cluster privileges monitor

Path parameters

id string required: The identifier for the search.

Response

application/json

expiration_time_in_millis number required: The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.
id string required: The identifier for the search.
is_running boolean required: If true, the search is still running. If false, the search has finished.
is_partial boolean required: If true, the response does not contain complete search results. If is_partial is true and is_running is true, the search is still running. If is_partial is true but is_running is false, the results are partial due to a failure or timeout.
start_time_in_millis number required: The timestamp, in milliseconds since the Unix epoch, when the search started. The API returns this property only for running searches.
completion_status number: The HTTP status code for the search. The API returns this property only for completed searches.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=

JavaScript Elasticsearch JavaScript Client

const response = await client.sql.getAsyncStatus({
  id: "FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=",
});

Python Elasticsearch Python Client

resp = client.sql.get_async_status(
    id="FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_sql/async/status/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.sql().getAsyncStatus(g -> g
    .id("FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=")
);

C# Elasticsearch .NET Client

var response = await client.Sql.GetAsyncStatusAsync(id: "FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=");

PHP Elasticsearch PHP Client

$resp = $client->sql()->getAsyncStatus([
    "id" => "FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=",
]);

Ruby Elasticsearch Ruby Client

response = client.sql.get_async_status(
  id: "FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU="
)

Response

{
  "expiration_time_in_millis": 0,
  "id": "string",
  "is_running": false,
  "is_partial": false,
  "start_time_in_millis": 0,
  "completion_status": 0
}

Generated from the API spec