get_stats.asciidoc 1016 B

12345678910111213141516171819202122232425262728293031323334353637
  1. --
  2. :api: ccr-get-stats
  3. :request: CcrStatsRequest
  4. :response: CcrStatsResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Get CCR Stats API
  8. [id="{upid}-{api}-request"]
  9. ==== Request
  10. The Get CCR Stats API allows you to get statistics about index following and auto following.
  11. ["source","java",subs="attributes,callouts,macros"]
  12. --------------------------------------------------
  13. include-tagged::{doc-tests-file}[{api}-request]
  14. --------------------------------------------------
  15. <1> The request accepts no parameters.
  16. [id="{upid}-{api}-response"]
  17. ==== Response
  18. The returned +{response}+ always includes index follow statistics of all follow indices and
  19. auto follow statistics.
  20. ["source","java",subs="attributes,callouts,macros"]
  21. --------------------------------------------------
  22. include-tagged::{doc-tests-file}[{api}-response]
  23. --------------------------------------------------
  24. <1> The follow stats of active follower indices.
  25. <2> The auto follow stats of the cluster that has been queried.
  26. include::../execution.asciidoc[]