IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get categories API Get datafeed statistics API »
Elastic Docs ›Elasticsearch Guide [7.16] ›REST APIs ›Machine learning anomaly detection APIs

Get datafeeds API

edit

Get datafeeds API

edit

Retrieves configuration information for datafeeds.

Request

edit

GET _ml/datafeeds/<feed_id>

GET _ml/datafeeds/<feed_id>,<feed_id>

GET _ml/datafeeds/

GET _ml/datafeeds/_all

Prerequisites

edit

Requires the monitor_ml cluster privilege. This privilege is included in the machine_learning_user built-in role.

Description

edit

This API returns a maximum of 10,000 datafeeds.

Path parameters

edit
<feed_id>

(Optional, string) Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression.

You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using _all, by specifying * as the datafeed identifier, or by omitting the identifier.

Query parameters

edit
allow_no_datafeeds
(Optional, Boolean) [7.10] Deprecated in 7.10. Use allow_no_match instead.
allow_no_match

(Optional, Boolean) Specifies what to do when the request:

  • Contains wildcard expressions and there are no datafeeds that match.
  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches.

The default value is true, which returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

exclude_generated
(Optional, Boolean) Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. Default is false.

Response body

edit

The API returns an array of datafeed resources. For the full list of properties, see create datafeeds API.

Response codes

edit
404 (Missing resources)
If allow_no_match is false, this code indicates that there are no resources that match the request or only partial matches for the request.

Examples

edit
GET _ml/datafeeds/datafeed-high_sum_total_sales

The API returns the following results:

{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-high_sum_total_sales",
      "job_id": "high_sum_total_sales",
      "query_delay": "93169ms",
      "indices": [
        "kibana_sample_data_ecommerce"
      ],
      "query" : {
        "bool" : {
          "filter" : [
            {
              "term" : {
                "_index" : "kibana_sample_data_ecommerce"
              }
            }
          ]
        }
      },
      "scroll_size": 1000,
      "chunking_config": {
        "mode": "auto"
      },
      "delayed_data_check_config" : {
        "enabled" : true
      }
    }
  ]
}
« Get categories API Get datafeed statistics API »