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
    • leader_index string Required
    • parameters object
      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 number | string

        One of:

        ByteSize number ByteSize string
      • max_retry_delay string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • 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 number | string

        One of:

        ByteSize number ByteSize string
      • max_write_request_operation_count number

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

      • max_write_request_size number | string

        One of:

        ByteSize number ByteSize string
      • read_poll_timeout string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • remote_cluster string Required
    • status string Required

      Values are active or paused.