honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Remove individual task retrieval from cat/tasks API (#49550)

This commit is contained in:
James Rodewig 2019-11-25 10:31:13 -05:00
parent 688c78c589
commit 99476db2d0
1 changed files with 0 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/reference/cat/tasks.asciidoc
View File

@ -13,8 +13,6 @@ similar to the <<tasks,task management>> API.
[[cat-tasks-api-request]]
==== {api-request-title}
`GET /_cat/tasks/<task_id>`
`GET /_cat/tasks`
@ -28,12 +26,6 @@ It is a more compact view
of the JSON <<tasks,task management>> API.
[[cat-tasks-api-path-params]]
==== {api-path-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=task-id]
[[cat-tasks-api-query-params]]
==== {api-query-parms-title}
@ -71,30 +63,6 @@ include::{docdir}/cluster/tasks.asciidoc[tag=tasks-api-404]
[[cat-tasks-api-examples]]
==== {api-examples-title}
[[cat-tasks-api-specific-ex]]
===== Get information for a specific task
[source,console]
----
GET _cat/tasks/oTUltX4IQMOUUVeiohTt8A:124?v
----
// TEST[skip:No tasks to retrieve]
The API returns the following response:
[source,txt]
----
action task_id parent_task_id type start_time timestamp running_time ip node
cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
----
// TESTRESPONSE[skip:No tasks to retrieve]
// TESTRESPONSE[non_json]
[[cat-tasks-api-all-ex]]
===== Get information for all tasks in a cluster
[source,console]
----
GET _cat/tasks?v