Files
elasticsearch-js/docs/reference-ml-get_datafeed_stats.asciidoc
2024-12-05 14:46:52 -06:00

76 lines
4.3 KiB
Plaintext

[[reference-ml-get_datafeed_stats]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
[[client.ml.getDatafeedStats]]
=== client.ml.getDatafeedStats
Get datafeeds usage info. 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.
{ref}/ml-get-datafeed-stats.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetDatafeedStatsRequest, options?): Promise<MlGetDatafeedStatsResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface MlGetDatafeedStatsRequest extends <<RequestBase>> {
datafeed_id?: <<Ids>>
allow_no_match?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface MlGetDatafeedStatsResponse {
count: <<long>>
datafeeds: <<MlDatafeedStats>>[]
}
[pass]
++++
</pre>
++++