elasticsearch/docs/reference/search
Mayya Sharipova 074f7d2e8a
Async search status (#62947)
Introduce async search status API

GET /_async_search/status/<id>

The API is restricted to the monitoring_user role.

For a running async search, the response is:

```js
{
  "id" : <id>,
  "is_running" : true,
  "is_partial" : true,
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986,
  "_shards" : {
      "total" : 562,
      "successful" : 188,
      "skipped" : 0,
      "failed" : 0
  }
}
```

For a completed async search, an additional
`completion_status` fields is added.

```js
{
  "id" : <id>,
  "is_running" : false,
  "is_partial" : false,
  "start_time_in_millis" : 1583945890986,
  "expiration_time_in_millis" : 1584377890986,
  "_shards" : {
      "total" : 562,
      "successful" : 562,
      "skipped" : 0,
      "failed" : 0
  },
 "completion_status" : 200
}
```

Closes #57537
2020-11-03 11:35:28 -05:00
..
search-your-data Mark the search 'fields' option as beta. (#63699) 2020-10-16 17:13:29 -07:00
suggesters [DOCS] Fix typo in suggester docs (#61077) (#61204) 2020-08-17 09:14:37 -04:00
async-search.asciidoc Async search status (#62947) 2020-11-03 11:35:28 -05:00
clear-scroll-api.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
count.asciidoc Deprecate REST access to System Indices (#60945) 2020-10-06 11:13:48 -06:00
explain.asciidoc [DOCS] Replace `twitter` dataset in search/agg docs (#60667) 2020-08-04 13:31:52 -04:00
field-caps.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
multi-search.asciidoc [DOCS] Rewrite aggs overview (#64318) 2020-10-30 08:39:38 -04:00
point-in-time-api.asciidoc [DOCS] Display point in time API docs (#61527) 2020-08-25 11:03:41 -04:00
profile.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
rank-eval.asciidoc Deprecate REST access to System Indices (#60945) 2020-10-06 11:13:48 -06:00
scroll-api.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
search-shards.asciidoc Deprecate REST access to System Indices (#60945) 2020-10-06 11:13:48 -06:00
search-template.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
search.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
suggesters.asciidoc [DOCS] Replace `twitter` dataset in search/agg docs (#60667) 2020-08-04 13:31:52 -04:00
validate.asciidoc [DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00