Get datafeeds

GET /_cat/ml/datafeeds/{datafeed_id}
GET /_cat/ml/datafeeds

Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.

Required authorization

Cluster privileges: monitor_ml

Path Parameters

datafeed_id string Id optional

A numerical character string that uniquely identifies the datafeed.

Leave it out to use /_cat/ml/datafeeds.

Query Parameters

allow_no_match boolean · default: true

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.

If true, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

h CatDatafeedColumns · default: ['bc', 'id', 'sc', 's']

Comma-separated list of column names to display.

Supported values include:

ae (or assignment_explanation): For started datafeeds only, contains messages relating to the selection of a node.
bc (or buckets.count, bucketsCount): The number of buckets processed.
id: A numerical character string that uniquely identifies the datafeed.
na (or node.address, nodeAddress): For started datafeeds only, the network address of the node where the datafeed is started.
ne (or node.ephemeral_id, nodeEphemeralId): For started datafeeds only, the ephemeral ID of the node where the datafeed is started.
ni (or node.id, nodeId): For started datafeeds only, the unique identifier of the node where the datafeed is started.
nn (or node.name, nodeName): For started datafeeds only, the name of the node where the datafeed is started.
sba (or search.bucket_avg, searchBucketAvg): The average search time per bucket, in milliseconds.
sc (or search.count, searchCount): The number of searches run by the datafeed.
seah (or search.exp_avg_hour, searchExpAvgHour): The exponential average search time per hour, in milliseconds.
st (or search.time, searchTime): The total time the datafeed spent searching, in milliseconds.
s (or state): The status of the datafeed: starting, started, stopping, or stopped. If starting, the datafeed has been requested to start but has not yet started. If started, the datafeed is actively receiving data. If stopping, the datafeed has been requested to stop gracefully and is completing its final action. If stopped, the datafeed is stopped and will not receive data until it is re-started.

s union CatDatafeedColumns

Comma-separated list of column names or column aliases used to sort the response.

Supported values include:

ae (or assignment_explanation): For started datafeeds only, contains messages relating to the selection of a node.
bc (or buckets.count, bucketsCount): The number of buckets processed.
id: A numerical character string that uniquely identifies the datafeed.
na (or node.address, nodeAddress): For started datafeeds only, the network address of the node where the datafeed is started.
ne (or node.ephemeral_id, nodeEphemeralId): For started datafeeds only, the ephemeral ID of the node where the datafeed is started.
ni (or node.id, nodeId): For started datafeeds only, the unique identifier of the node where the datafeed is started.
nn (or node.name, nodeName): For started datafeeds only, the name of the node where the datafeed is started.
sba (or search.bucket_avg, searchBucketAvg): The average search time per bucket, in milliseconds.
sc (or search.count, searchCount): The number of searches run by the datafeed.
seah (or search.exp_avg_hour, searchExpAvgHour): The exponential average search time per hour, in milliseconds.
st (or search.time, searchTime): The total time the datafeed spent searching, in milliseconds.
s (or state): The status of the datafeed: starting, started, stopping, or stopped. If starting, the datafeed has been requested to start but has not yet started. If started, the datafeed is actively receiving data. If stopping, the datafeed has been requested to stop gracefully and is completing its final action. If stopped, the datafeed is stopped and will not receive data until it is re-started.

One of: CatDatafeedColumn or CatDatafeedColumn[]

Response

application/json

Examples

A successful response from GET _cat/ml/datafeeds?v=true&format=json.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _cat/ml/datafeeds?v=true&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.mlDatafeeds({
  v: "true",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.ml_datafeeds(
    v=True,
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/ml/datafeeds?v=true&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().mlDatafeeds(m -> m);

PHP Elasticsearch PHP Client

$resp = $client->cat()->mlDatafeeds([
    "v" => "true",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.ml_datafeeds(
  v: "true",
  format: "json"
)

Response

[
  {
    "id": "datafeed-high_sum_total_sales",
    "state": "stopped",
    "buckets.count": "743",
    "search.count": "7"
  },
  {
    "id": "datafeed-low_request_rate",
    "state": "stopped",
    "buckets.count": "1457",
    "search.count": "3"
  },
  {
    "id": "datafeed-response_code_rates",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  },
  {
    "id": "datafeed-url_scanning",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  }
]

Required authorization

Path Parameters

Query Parameters { allow_no_match , h , s , }

Response

Query Parameters