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.2] ›X-Pack APIs ›Machine learning 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
  • You must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Description

edit

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 <feed_id>, or by omitting the <feed_id>.

This API returns a maximum of 10,000 datafeeds.

Path parameters

edit
feed_id
(string) Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.

Query parameters

edit
allow_no_datafeeds

(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.

Response body

edit

The API returns the following information:

datafeeds
(array) An array of datafeed objects. For more information, see Datafeed resources.

Response codes

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

Examples

edit

The following example gets configuration information for the datafeed-total-requests datafeed:

GET _ml/datafeeds/datafeed-total-requests

The API returns the following results:

{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-total-requests",
      "job_id": "total-requests",
      "query_delay": "83474ms",
      "indices": [
        "server-metrics"
      ],
      "query": {
        "match_all": {
          "boost": 1.0
        }
      },
      "scroll_size": 1000,
      "chunking_config": {
        "mode": "auto"
      }
    }
  ]
}
« Get categories API Get datafeed statistics API »