Path parameters

• index string | array[string] Required

  A comma-delimited list of index patterns.

Query parameters

• timeout string

  The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  Values are -1 or 0.

Responses

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

  • indices array[object] Required

    An array of follower index statistics.

    Hide indices attributes Show indices attributes object

    • index string Required
    • shards array[object] Required

      An array of shard-level following task statistics.

      Hide shards attributes Show shards attributes object

      • bytes_read number Required

        The total of transferred bytes read from the leader. This is only an estimate and does not account for compression if enabled.

      • failed_read_requests number Required

        The number of failed reads.

      • failed_write_requests number Required

        The number of failed bulk write requests on the follower.

      • fatal_exception object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide fatal_exception attributes Show fatal_exception attributes object

        • type string Required

          The type of error

        • reason
        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_cause array[object]
        • suppressed array[object]
      • follower_aliases_version number Required
      • follower_global_checkpoint number Required

        The current global checkpoint on the follower. The difference between the leader_global_checkpoint and the follower_global_checkpoint is an indication of how much the follower is lagging the leader.

      • follower_index string Required

        The name of the follower index.

      • follower_mapping_version number Required
      • follower_max_seq_no number Required
      • follower_settings_version number Required
      • last_requested_seq_no number Required
      • leader_global_checkpoint number Required

        The current global checkpoint on the leader known to the follower task.

      • leader_index string Required

        The name of the index in the leader cluster being followed.

      • leader_max_seq_no number Required
      • operations_read number Required

        The total number of operations read from the leader.

      • operations_written number Required

        The number of operations written on the follower.

      • outstanding_read_requests number Required

        The number of active read requests from the follower.

      • outstanding_write_requests number Required

        The number of active bulk write requests on the follower.

      • read_exceptions array[object] Required

        An array of objects representing failed reads.
      • remote_cluster string Required

        The remote cluster containing the leader index.

      • shard_id number Required

        The numerical shard ID, with values from 0 to one less than the number of replicas.

      • successful_read_requests number Required

        The number of successful fetches.

      • successful_write_requests number Required

        The number of bulk write requests run on the follower.

      • time_since_last_read 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.

      • time_since_last_read_millis number

        Time unit for milliseconds

      • total_read_remote_exec_time 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.

      • total_read_remote_exec_time_millis number

        Time unit for milliseconds

      • total_read_time 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.

      • total_read_time_millis number

        Time unit for milliseconds

      • total_write_time 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.

      • total_write_time_millis number

        Time unit for milliseconds

      • write_buffer_operation_count number Required

        The number of write operations queued on the follower.

      • write_buffer_size_in_bytes number | string Required

        One of:

        ByteSize number ByteSize string