Get follower information | Elasticsearch API documentation

Path parameters

indexstring | array[string] Required
A comma-delimited list of follower index patterns.

Query parameters

master_timeoutstring
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_indicesarray[object] Required
  Hide follower_indices attributes Show follower_indices attributes object
  follower_indexstring Required
  leader_indexstring Required
  parametersobject
  Hide parameters attributes Show parameters attributes object
  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
  One of:
  ByteSizenumber ByteSizestring
  max_retry_delaystring
  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_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
  One of:
  ByteSizenumber ByteSizestring
  max_write_request_operation_countnumber
  The maximum number of operations per bulk write request executed on the follower.
  max_write_request_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  read_poll_timeoutstring
  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_clusterstring Required
  statusstring Required
  Values are active or paused.

GET /{index}/_ccr/info

GET /follower_index/_ccr/info

resp = client.ccr.follow_info(
    index="follower_index",
)

const response = await client.ccr.followInfo({
  index: "follower_index",
});

response = client.ccr.follow_info(
  index: "follower_index"
)

$resp = $client->ccr()->followInfo([
    "index" => "follower_index",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/follower_index/_ccr/info"

Response examples (200)

A successful response from `GET /follower_index/_ccr/info` when the follower index is active.

{
  "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"
      }
    }
  ]
}

A successful response from `GET /follower_index/_ccr/info` when the follower index is paused.

{
  "follower_indices": [
    {
      "follower_index": "follower_index",
      "remote_cluster": "remote_cluster",
      "leader_index": "leader_index",
      "status": "paused"
    }
  ]
}

Path parameters

Query parameters

Responses

max_read_request_sizenumber | string

max_write_buffer_sizenumber | string

max_write_request_sizenumber | string