get-data-frame-analytics-stats.asciidoc 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. --
  2. :api: get-data-frame-analytics-stats
  3. :request: GetDataFrameAnalyticsStatsRequest
  4. :response: GetDataFrameAnalyticsStatsResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Get {dfanalytics-jobs} stats API
  9. beta::[]
  10. Retrieves the operational statistics of one or more {dfanalytics-jobs}.
  11. The API accepts a +{request}+ object and returns a +{response}+.
  12. [id="{upid}-{api}-request"]
  13. ==== Get {dfanalytics-jobs} stats request
  14. A +{request}+ requires either a {dfanalytics-job} ID, a comma-separated list of
  15. IDs, or the special wildcard `_all` to get the statistics for all
  16. {dfanalytics-jobs}.
  17. ["source","java",subs="attributes,callouts,macros"]
  18. --------------------------------------------------
  19. include-tagged::{doc-tests-file}[{api}-request]
  20. --------------------------------------------------
  21. <1> Constructing a new GET stats request referencing an existing
  22. {dfanalytics-job}
  23. include::../execution.asciidoc[]
  24. [id="{upid}-{api}-response"]
  25. ==== Response
  26. The returned +{response}+ contains the requested {dfanalytics-job} statistics.
  27. ["source","java",subs="attributes,callouts,macros"]
  28. --------------------------------------------------
  29. include-tagged::{doc-tests-file}[{api}-response]
  30. --------------------------------------------------