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

1.1 KiB

layout title parent grand_parent nav_order
default Delete controller Controller APIs ML Commons APIs 50

Delete a controller

Introduced 2.12 {: .label .label-purple }

Use this API to delete a controller for a model based on the model_id.

Path and HTTP methods

DELETE /_plugins/_ml/controllers/<model_id>

Path parameters

The following table lists the available path parameters.

Parameter Data type Description
model_id String The model ID of the model for which to delete the controller.

Example request

DELETE /_plugins/_ml/controllers/MzcIJX8BA7mbufL6DOwl

{% include copy-curl.html %}

Example response

{
  "_index" : ".plugins-ml-controller",
  "_id" : "MzcIJX8BA7mbufL6DOwl",
  "_version" : 2,
  "result" : "deleted",
  "_shards" : {
    "total" : 2,
    "successful" : 2,
    "failed" : 0
  },
  "_seq_no" : 27,
  "_primary_term" : 18
}

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: cluster:admin/opensearch/ml/controllers/delete.