cat pending tasks API

cat pending tasks API

New API reference

For the most up-to-date API details, refer to Compact and aligned text (CAT) APIs..

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.

Request

GET /_cat/pending_tasks

Prerequisites

  • If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Query parameters

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 to false.

local

(Optional, Boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

master_timeout

(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

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 to false.

Examples

  1. resp = client.cat.pending_tasks(
  2.     v=True,
  3. )
  4. print(resp)
  1. response = client.cat.pending_tasks(
  2.   v: true
  3. )
  4. puts response
  1. const response = await client.cat.pendingTasks({
  2.   v: "true",
  3. });
  4. console.log(response);
  1. GET /_cat/pending_tasks?v=true

The API returns the following response:

  1. insertOrder timeInQueue priority source
  2.        1685       855ms HIGH     update-mapping [foo][t]
  3.        1686       843ms HIGH     update-mapping [foo][t]
  4.        1693       753ms HIGH     refresh-mapping [foo][[t]]
  5.        1688       816ms HIGH     update-mapping [foo][t]
  6.        1689       802ms HIGH     update-mapping [foo][t]
  7.        1690       787ms HIGH     update-mapping [foo][t]
  8.        1691       773ms HIGH     update-mapping [foo][t]