OpenSearch/docs/reference/cat/pending_tasks.asciidoc

55 lines
1.7 KiB
Plaintext

[[cat-pending-tasks]]
=== cat pending tasks
Returns cluster-level changes that have not yet been executed, similar to the
<<cluster-pending, pending cluster tasks>> API.
[[cat-pending-tasks-api-request]]
==== {api-request-title}
`GET /_cat/pending_tasks`
[[cat-pending-tasks-api-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-pending-tasks-api-example]]
==== {api-examples-title}
[source,js]
--------------------------------------------------
GET /_cat/pending_tasks?v
--------------------------------------------------
// CONSOLE
The API returns the following response:
[source,txt]
--------------------------------------------------
insertOrder timeInQueue priority source
1685 855ms HIGH update-mapping [foo][t]
1686 843ms HIGH update-mapping [foo][t]
1693 753ms HIGH refresh-mapping [foo][[t]]
1688 816ms HIGH update-mapping [foo][t]
1689 802ms HIGH update-mapping [foo][t]
1690 787ms HIGH update-mapping [foo][t]
1691 773ms HIGH update-mapping [foo][t]
--------------------------------------------------
// TESTRESPONSE[s/(\n.+)+/(\\n.+)*/ non_json]
// We can't assert anything about the tasks in progress here because we don't
// know what might be in progress....