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.

« snapshot.verifyRepository tasks.get »
Elastic Docs ›elasticsearch.js ›7.4 API

tasks.cancel

edit

tasks.cancel

edit
client.tasks.cancel([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 cancelled. Leave empty to cancel all.

parentTaskId

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

taskId

String — Cancel the task with specified task id (node_id:task_number)

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

« snapshot.verifyRepository tasks.get »