get_follow_info.asciidoc 999 B

1234567891011121314151617181920212223242526272829303132333435
  1. --
  2. :api: ccr-get-follow-info
  3. :request: FollowInfoRequest
  4. :response: FollowInfoResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Get Follow Info API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Get Follow Info API allows you to get follow information (parameters and status) for specific follower indices.
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. <1> The follower index to get follow information for.
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned +{response}+ includes follow information for the specified follower indices
  20. ["source","java",subs="attributes,callouts,macros"]
  21. --------------------------------------------------
  22. include-tagged::{doc-tests-file}[{api}-response]
  23. --------------------------------------------------
  24. <1> The follow information for specified follower indices.
  25. include::../execution.asciidoc[]