opensearch-docs-cn/_ml-commons-plugin/api/model-apis/undeploy-model.md

1.1 KiB

layout title parent grand_parent nav_order
default Undeploy model Model APIs ML Commons APIs 45

Undeploy a model

To undeploy a model from memory, use the undeploy operation.

For information about user access for this API, see Model access control considerations.

Path and HTTP methods

POST /_plugins/_ml/models/<model_id>/_undeploy

Example request: Undeploying a model from all ML nodes

POST /_plugins/_ml/models/MGqJhYMBbbh0ushjm8p_/_undeploy

{% include copy-curl.html %}

Example request: Undeploying specific models from specific nodes

POST /_plugins/_ml/models/_undeploy
{
  "node_ids": ["sv7-3CbwQW-4PiIsDOfLxQ"],
  "model_ids": ["KDo2ZYQB-v9VEDwdjkZ4"]
}

{% include copy-curl.html %}

Example request: Undeploying specific models from all nodes

{
  "model_ids": ["KDo2ZYQB-v9VEDwdjkZ4"]
}

{% include copy-curl.html %}

Example response

{
  "sv7-3CbwQW-4PiIsDOfLxQ" : {
    "stats" : {
      "KDo2ZYQB-v9VEDwdjkZ4" : "UNDEPLOYED"
    }
  }
}