Quick links
Overview
A task is an OpenSearch operation, which can be any request performed on an OpenSearch cluster, such as a delete by query request, a search request and so on. OpenSearch provides a dedicated Task API for the task management which includes various actions, from retrieving the status of current running tasks to canceling any long running task.
Examples
Get all currently running tasks on all nodes of the cluster
Apart from other information, the response of the below request contains task IDs of all the tasks which can be used to get detailed information about the particular task in question.
GET _tasks
Get detailed information of a particular task
Where clQFAL_VRrmnlRyPsu_p8A:1132678759 is the ID of the task in below request
GET _tasks/clQFAL_VRrmnlRyPsu_p8A:1132678759
Get all the current tasks running on particular nodes
GET _tasks?nodes=nodeId1,nodeId2
Where clQFAL_VRrmnlRyPsu_p8A:1132678759 is the ID of the task in the below request
Cancel a task
POST /_tasks/clQFAL_VRrmnlRyPsu_p8A:1132678759/_cancel?pretty
Notes
The Task API will be most useful when you want to investigate the spike of resource utilization in the cluster or want to cancel an operation.
