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

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