Path parameters

• index string | array[string] Required

  A comma-delimited list of follower index patterns.

Query parameters

• master_timeout string

  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.

  Values are -1 or 0.

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • follower_indices array[object] Required
    Hide follower_indices attributes Show follower_indices attributes object

    • follower_index string Required

      The name of the follower index.

    • leader_index string Required

      The name of the index in the leader cluster that is followed.

    • parameters object

      An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted.

      Hide parameters attributes Show parameters attributes object

      • max_outstanding_read_requests number

        The maximum number of outstanding reads requests from the remote cluster.

      • max_outstanding_write_requests number

        The maximum number of outstanding write requests on the follower.

      • max_read_request_operation_count number

        The maximum number of operations to pull per read from the remote cluster.

      • max_read_request_size
      • max_retry_delay string

        The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.

      • max_write_buffer_count number

        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_size
      • max_write_request_operation_count number

        The maximum number of operations per bulk write request executed on the follower.

      • max_write_request_size
      • read_poll_timeout string

        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.

    • remote_cluster string Required

      The remote cluster that contains the leader index.

    • status string Required

      The status of the index following: active or paused.

      Values are active or paused.