opensearch-docs-cn/_ml-commons-plugin/api/tasks-apis/delete-task.md

885 B

layout title parent grand_parent nav_order
default Delete task Tasks APIs ML Commons API 20

Delete a task

Deletes a task based on the task_id.

ML Commons does not check the task status when running the delete request. There is a risk that a currently running task could be deleted before the task completes. To check the status of a task, run GET /_plugins/_ml/tasks/<task_id> before task deletion. {: .note}

Path and HTTP methods

DELETE /_plugins/_ml/tasks/<task_id>

Example request

DELETE /_plugins/_ml/tasks/xQRYLX8BydmmU1x6nuD3

{% include copy-curl.html %}

Example response

{
  "_index" : ".plugins-ml-task",
  "_id" : "xQRYLX8BydmmU1x6nuD3",
  "_version" : 4,
  "result" : "deleted",
  "_shards" : {
    "total" : 2,
    "successful" : 2,
    "failed" : 0
  },
  "_seq_no" : 42,
  "_primary_term" : 7
}