OpenSearch/docs/java-rest/high-level/ccr/get_follow_info.asciidoc

36 lines
999 B
Plaintext
Raw Normal View History

--
:api: ccr-get-follow-info
:request: FollowInfoRequest
:response: FollowInfoResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Get Follow Info API
[id="{upid}-{api}-request"]
==== Request
The Get Follow Info API allows you to get follow information (parameters and status) for specific follower indices.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The follower index to get follow information for.
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ includes follow information for the specified follower indices
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> The follow information for specified follower indices.
include::../execution.asciidoc[]