get-auto-follow-stats.asciidoc 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[ccr-get-auto-follow-stats]]
  4. === Get Auto-Follow Stats API
  5. ++++
  6. <titleabbrev>Get Auto-Follow Stats</titleabbrev>
  7. ++++
  8. Get auto-follow stats.
  9. ==== Description
  10. This API gets stats about auto-follow patterns.
  11. ==== Request
  12. [source,js]
  13. --------------------------------------------------
  14. GET /_ccr/auto_follow/stats
  15. --------------------------------------------------
  16. // CONSOLE
  17. // TEST
  18. ==== Example
  19. This example retrieves stats about auto-follow patterns:
  20. [source,js]
  21. --------------------------------------------------
  22. GET /_ccr/auto_follow/stats
  23. --------------------------------------------------
  24. // CONSOLE
  25. // TEST
  26. The API returns the following result:
  27. [source,js]
  28. --------------------------------------------------
  29. {
  30. "number_of_successful_follow_indices" : 16,
  31. "number_of_failed_follow_indices" : 0,
  32. "number_of_failed_remote_cluster_state_requests" : 0,
  33. "recent_auto_follow_errors" : [ ]
  34. }
  35. --------------------------------------------------
  36. // TESTRESPONSE[s/"number_of_successful_follow_indices" : 16/"number_of_successful_follow_indices" : $body.number_of_successful_follow_indices/]