1
0

esql-async-query-get-api.asciidoc 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. [[esql-async-query-get-api]]
  2. === {esql} async query get API
  3. ++++
  4. <titleabbrev>{esql} async query get API</titleabbrev>
  5. ++++
  6. Returns the current status and available results for an <<esql-async-query-api,{esql}
  7. async query>> or a stored results.
  8. [source,console]
  9. ----
  10. GET /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
  11. ----
  12. // TEST[skip: no access to query ID]
  13. [[esql-async-query-get-api-request]]
  14. ==== {api-request-title}
  15. `GET /_query/async/<query_id>`
  16. [[esql-async-query-get-api-prereqs]]
  17. ==== {api-prereq-title}
  18. * If the {es} {security-features} are enabled, only the user who first submitted
  19. the {esql} query can retrieve the results using this API.
  20. [[esql-async-query-get-api-path-params]]
  21. ==== {api-path-parms-title}
  22. `<query_id>`::
  23. (Required, string)
  24. Identifier for the query.
  25. +
  26. A query ID is provided in the <<esql-async-query-api,{esql} async query API>>'s
  27. response for a query that does not complete in the awaited time. A query ID is
  28. also provided if the request's <<esql-async-query-api-keep-on-completion,`keep_on_completion`>>
  29. parameter is `true`.
  30. [[esql-async-query-get-api-query-params]]
  31. ==== {api-query-parms-title}
  32. `wait_for_completion_timeout`::
  33. (Optional, <<time-units,time value>>)
  34. Timeout duration to wait for the request to finish. Defaults to no timeout,
  35. meaning the request waits for complete query results.
  36. +
  37. If this parameter is specified and the request completes during this period,
  38. complete query results are returned.
  39. +
  40. If the request does not complete during this period, the response returns an
  41. `is_running` value of `true` and no results.
  42. [[esql-async-query-get-api-response-body]]
  43. ==== {api-response-body-title}
  44. The {esql} async query get API returns the same response body as the {esql}
  45. query API. See the {esql} query API's <<esql-query-api-response-body,response
  46. body parameters>>.