get_stats.asciidoc 1.0 KB

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