34 lines
1.3 KiB
Plaintext
34 lines
1.3 KiB
Plaintext
--
|
|
:api: get-data-frame-analytics-stats
|
|
:request: GetDataFrameAnalyticsStatsRequest
|
|
:response: GetDataFrameAnalyticsStatsResponse
|
|
--
|
|
[id="{upid}-{api}"]
|
|
=== Get Data Frame Analytics Stats API
|
|
|
|
The Get Data Frame Analytics Stats API is used to read the operational statistics of one or more {dataframe-analytics-config}s.
|
|
The API accepts a +{request}+ object and returns a +{response}+.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Get Data Frame Analytics 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
|
|
|
|
["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}
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ contains the requested {dataframe-analytics-config} statistics.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
-------------------------------------------------- |