IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« cat.snapshots cat.templates »
Elastic Docs ›elasticsearch.js ›7.3 API

cat.tasks

edit

cat.tasks

edit
client.cat.tasks([params, [callback]])

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

format

String — a short version of the Accept header, e.g. json, yaml

nodeId

String, String[], Boolean — A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you’re connecting to, leave empty to get information from all nodes

actions

String, String[], Boolean — A comma-separated list of actions that should be returned. Leave empty to return all.

detailed

Boolean — Return detailed task information (default: false)

parentTask

Number — Return tasks with specified parent task id. Set to -1 to return all.

h

String, String[], Boolean — Comma-separated list of column names to display

help

Boolean — Return help information

s

String, String[], Boolean — Comma-separated list of column names or column aliases to sort by

time

String — The unit in which to display time values

Options
  • "d (Days)"
  • "h (Hours)"
  • "m (Minutes)"
  • "s (Seconds)"
  • "ms (Milliseconds)"
  • "micros (Microseconds)"
  • "nanos (Nanoseconds)"

v

Boolean — Verbose mode. Display column headers

back to top

« cat.snapshots cat.templates »