Retrieves information about all follower indices.
This API lists the parameters and the status for each follower index. For example, the results include follower index names, leader index names, replication options and whether the follower indices are active or paused.
This API returns the following information:
follower_indices
The indices
array consists of objects containing several fields:
indices[].follower_index
indices[].remote_cluster
indices[].leader_index
indices[].status
active
or paused
indices[].parameters
The parameters
contains the following fields:
indices[].parameters.max_read_request_operation_count
indices[].parameters.max_outstanding_read_requests
indices[].parameters.max_read_request_size
indices[].parameters.max_write_request_operation_count
indices[].parameters.max_write_request_size
indices[].parameters.max_outstanding_write_requests
indices[].parameters.max_write_buffer_count
indices[].parameters.max_write_buffer_size
indices[].parameters.max_retry_delay
indices[].parameters.read_poll_timeout
If the Elasticsearch security features are enabled, you must have monitor
cluster
privileges. For more information, see
Security privileges.
This example retrieves follower info:
GET /follower_index/_ccr/info
The API returns the following results:
{ "follower_indices" : [ { "follower_index" : "follower_index", "remote_cluster" : "remote_cluster", "leader_index" : "leader_index", "status" : "active", "parameters" : { "max_read_request_operation_count" : 5120, "max_read_request_size" : "32mb", "max_outstanding_read_requests" : 12, "max_write_request_operation_count" : 5120, "max_write_request_size" : "9223372036854775807b", "max_outstanding_write_requests" : 9, "max_write_buffer_count" : 2147483647, "max_write_buffer_size" : "512mb", "max_retry_delay" : "500ms", "read_poll_timeout" : "1m" } } ] }