|
@@ -5,29 +5,31 @@
|
|
|
--
|
|
|
[role="xpack"]
|
|
|
[id="{upid}-{api}"]
|
|
|
-=== Get Data Frame Analytics Stats API
|
|
|
+=== Get {dfanalytics-jobs} stats API
|
|
|
|
|
|
-The Get Data Frame Analytics Stats API is used to read the operational statistics of one or more {dataframe-analytics-config}s.
|
|
|
+Retrieves the operational statistics of one or more {dfanalytics-jobs}.
|
|
|
The API accepts a +{request}+ object and returns a +{response}+.
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
|
-==== Get Data Frame Analytics Stats Request
|
|
|
+==== Get {dfanalytics-jobs} stats request
|
|
|
|
|
|
-A +{request}+ requires either a {dataframe-analytics-config} id, a comma separated list of ids or
|
|
|
-the special wildcard `_all` to get the statistics for all {dataframe-analytics-config}s
|
|
|
+A +{request}+ requires either a {dfanalytics-job} ID, a comma-separated list of
|
|
|
+IDs, or the special wildcard `_all` to get the statistics for all
|
|
|
+{dfanalytics-jobs}.
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
--------------------------------------------------
|
|
|
-<1> Constructing a new GET Stats request referencing an existing {dataframe-analytics-config}
|
|
|
+<1> Constructing a new GET stats request referencing an existing
|
|
|
+{dfanalytics-job}
|
|
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
==== Response
|
|
|
|
|
|
-The returned +{response}+ contains the requested {dataframe-analytics-config} statistics.
|
|
|
+The returned +{response}+ contains the requested {dfanalytics-job} statistics.
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
--------------------------------------------------
|