tasks.asciidoc 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
  26. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
  27. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
  28. [[cat-tasks-api-response-codes]]
  29. ==== {api-response-codes-title}
  30. include::{es-repo-dir}/cluster/tasks.asciidoc[tag=tasks-api-404]
  31. [[cat-tasks-api-examples]]
  32. ==== {api-examples-title}
  33. [source,console]
  34. ----
  35. GET _cat/tasks?v
  36. ----
  37. // TEST[skip:No tasks to retrieve]
  38. The API returns the following response:
  39. [source,console-result]
  40. ----
  41. action task_id parent_task_id type start_time timestamp running_time ip node
  42. cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
  43. cluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport 1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
  44. ----
  45. // TESTRESPONSE[skip:No tasks to retrieve]
  46. // TESTRESPONSE[non_json]