Get datafeed stats
- GET /_ml/datafeeds/{datafeed_id}/_stats
- GET /_ml/datafeeds/_stats
You can get statistics for multiple datafeeds in a single API request by
using a comma-separated list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using _all, by specifying * as the
<feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the
only information you receive is the datafeed_id and the state.
This API returns a maximum of 10,000 datafeeds.
Required authorization
- Cluster privileges monitor_ml
Query parameters
-
allow_no_matchboolean -
Specifies what to do when the request:
- Contains wildcard expressions and there are no datafeeds that match.
- Contains the
_allstring 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 emptydatafeedsarray when there are no matches and the subset of results when there are partial matches. If this parameter isfalse, the request returns a404status code when there are no matches or only partial matches.
Response
-
datafeedsobjectrequired -
assignment_explanationstring -
For started datafeeds only, contains messages relating to the selection of a node.
-
datafeed_idstringrequired -
A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
-
nodeobject -
For started datafeeds only, this information pertains to the node upon which the datafeed is started.
-
staterequired -
The status of the datafeed, which can be one of the following values:
starting,started,stopping,stopped. -
Values:
startedstoppedstartingstopping -
timing_statsobject -
An object that provides statistical information about timing aspect of this datafeed.
-
running_stateobject -
An object containing the running state for this datafeed. It is only provided if the datafeed is started.