cat pending tasks APIedit
cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
Returns cluster-level changes that have not yet been executed, similar to the pending cluster tasks API.
Requestedit
GET /_cat/pending_tasks
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
monitorormanagecluster privilege to use this API.
Query parametersedit
-
format - (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
h - (Optional, string) Comma-separated list of column names to display.
-
help -
(Optional, Boolean) If
true, the response includes help information. Defaults tofalse. -
local -
(Optional, Boolean) If
true, the request retrieves information from the local node only. Defaults tofalse, which means information is retrieved from the master node. -
master_timeout -
(Optional, time units)
Period to wait for a connection to the master node. If no response is received
before the timeout expires, the request fails and returns an error. Defaults to
30s. -
s - (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
time - (Optional, time units) Unit used to display time values.
-
v -
(Optional, Boolean) If
true, the response includes column headings. Defaults tofalse.
Examplesedit
GET /_cat/pending_tasks?v=true
The API returns the following response:
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]