Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 2.16 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Get a controller

Introduced 2.12

Use this API to retrieve information about a controller for a model by model ID.

Path and HTTP methods

GET /_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 retrieve the controller.

Example request

GET /_plugins/_ml/controllers/T_S-cY0BKCJ3ot9qr0aP

Example response

{
  "model_id": "T_S-cY0BKCJ3ot9qr0aP",
  "user_rate_limiter": {
    "user1": {
      "limit": "4",
      "unit": "MINUTES"
    },
    "user2": {
      "limit": "4",
      "unit": "MINUTES"
    }
  }
}

If there is no controller defined for the model, OpenSearch returns an error:

{
  "error": {
    "root_cause": [
      {
        "type": "status_exception",
        "reason": "Failed to find model controller with the provided model ID: T_S-cY0BKCJ3ot9qr0aP"
      }
    ],
    "type": "status_exception",
    "reason": "Failed to find model controller with the provided model ID: T_S-cY0BKCJ3ot9qr0aP"
  },
  "status": 404
}

Response fields

For response field descriptions, see Create Controller API request fields.

Required permissions

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

350 characters left

Have a question? .

Want to contribute? or .