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.

« tasks.get 7.2 API »
Elastic Docs ›elasticsearch.js ›7.3 API

tasks.list

edit

tasks.list

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

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

Params

nodes

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)

parentTaskId

String — Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.

waitForCompletion

Boolean — Wait for the matching tasks to complete (default: false)

[groupBy=nodes]

String — Group tasks by nodes or parent/child relationships

Options
  • "nodes"
  • "parents"
  • "none"

timeout

DurationString — Explicit operation timeout

back to top

« tasks.get 7.2 API »