AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 6.7This functionality is generally available and ready for production usage.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Get information about all cross-cluster replication follower indices.
For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.
The period to wait for a connection to the master node.
If the master node is not available before the timeout expires, the request fails and returns an error.
It can also be set to -1 to indicate that the request should never timeout.
The name of the index in the leader cluster that is followed.
parametersobject
An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted.
max_outstanding_read_requestsnumber
The maximum number of outstanding reads requests from the remote cluster.
max_outstanding_write_requestsnumber
The maximum number of outstanding write requests on the follower.
max_read_request_operation_countnumber
The maximum number of operations to pull per read from the remote cluster.
max_read_request_sizenumber | string
The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.
max_retry_delayuniononeOf
The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when
retrying.
Values:-10
max_write_buffer_countnumber
The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be
deferred until the number of queued operations goes below the limit.
max_write_buffer_sizenumber | string
The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will
be deferred until the total bytes of queued operations goes below the limit.
max_write_request_operation_countnumber
The maximum number of operations per bulk write request executed on the follower.
max_write_request_sizenumber | string
The maximum total bytes of operations per bulk write request executed on the follower.
read_poll_timeoutuniononeOf
The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.
When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics.
Then the follower will immediately attempt to read from the leader again.
Values:-10
remote_clusterstringrequired
The remote cluster that contains the leader index.
statusenumrequired
The status of the index following: active or paused.