tasks.asciidoc 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. [[cat-tasks]]
  2. === cat task management API
  3. ++++
  4. <titleabbrev>cat task management</titleabbrev>
  5. ++++
  6. beta::["The cat task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.",{es-issue}51628]
  7. Returns information about tasks currently executing in the cluster,
  8. similar to the <<tasks,task management>> API.
  9. [[cat-tasks-api-request]]
  10. ==== {api-request-title}
  11. `GET /_cat/tasks`
  12. [[cat-tasks-api-desc]]
  13. ==== {api-description-title}
  14. The cat task management API returns information
  15. about tasks currently executing
  16. on one or more nodes in the cluster.
  17. It is a more compact view
  18. of the JSON <<tasks,task management>> API.
  19. [[cat-tasks-api-query-params]]
  20. ==== {api-query-parms-title}
  21. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=detailed]
  22. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
  23. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
  24. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
  25. `nodes`::
  26. (Optional, string)
  27. Comma-separated list of node IDs or names used to limit the response. Supports
  28. wildcard (`*`) expressions.
  29. `parent_task_id`::
  30. (Optional, string)
  31. Parent task ID used to limit the response.
  32. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
  33. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
  34. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
  35. [[cat-tasks-api-response-codes]]
  36. ==== {api-response-codes-title}
  37. include::{es-repo-dir}/cluster/tasks.asciidoc[tag=tasks-api-404]
  38. [[cat-tasks-api-examples]]
  39. ==== {api-examples-title}
  40. [source,console]
  41. ----
  42. GET _cat/tasks?v=true
  43. ----
  44. // TEST[skip:No tasks to retrieve]
  45. The API returns the following response:
  46. [source,console-result]
  47. ----
  48. action task_id parent_task_id type start_time timestamp running_time ip node
  49. cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
  50. cluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport 1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
  51. ----
  52. // TESTRESPONSE[skip:No tasks to retrieve]
  53. // TESTRESPONSE[non_json]