Resume a follower

POST /{index}/_ccr/resume_follow

Auth

Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index.

About cross-cluster replication

Required privileges

Index privileges manage_follow_index
Cluster privileges manage_ccr

Path parameters

index string required: Name of the follow index to resume following

Query parameters

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node.; Values: -1 0

Request body

max_outstanding_read_requests number
max_outstanding_write_requests number
max_read_request_operation_count number
max_read_request_size string
max_retry_delay union oneOf: Values: -1 0
max_write_buffer_count number
max_write_buffer_size string
max_write_request_operation_count number
max_write_request_size string
read_poll_timeout union oneOf: Values: -1 0

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Run POST /follower_index/_ccr/resume_follow to resume the follower index.

Console Kibana Dev Tools

POST /follower_index/_ccr/resume_follow
{
  "max_read_request_operation_count" : 1024,
  "max_outstanding_read_requests" : 16,
  "max_read_request_size" : "1024k",
  "max_write_request_operation_count" : 32768,
  "max_write_request_size" : "16k",
  "max_outstanding_write_requests" : 8,
  "max_write_buffer_count" : 512,
  "max_write_buffer_size" : "512k",
  "max_retry_delay" : "10s",
  "read_poll_timeout" : "30s"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ccr.resumeFollow({
  index: "follower_index",
  max_read_request_operation_count: 1024,
  max_outstanding_read_requests: 16,
  max_read_request_size: "1024k",
  max_write_request_operation_count: 32768,
  max_write_request_size: "16k",
  max_outstanding_write_requests: 8,
  max_write_buffer_count: 512,
  max_write_buffer_size: "512k",
  max_retry_delay: "10s",
  read_poll_timeout: "30s",
});

Python Elasticsearch Python Client

resp = client.ccr.resume_follow(
    index="follower_index",
    max_read_request_operation_count=1024,
    max_outstanding_read_requests=16,
    max_read_request_size="1024k",
    max_write_request_operation_count=32768,
    max_write_request_size="16k",
    max_outstanding_write_requests=8,
    max_write_buffer_count=512,
    max_write_buffer_size="512k",
    max_retry_delay="10s",
    read_poll_timeout="30s",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/follower_index/_ccr/resume_follow" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "max_read_request_operation_count": 1024,
    "max_outstanding_read_requests": 16,
    "max_read_request_size": "1024k",
    "max_write_request_operation_count": 32768,
    "max_write_request_size": "16k",
    "max_outstanding_write_requests": 8,
    "max_write_buffer_count": 512,
    "max_write_buffer_size": "512k",
    "max_retry_delay": "10s",
    "read_poll_timeout": "30s"
  }'

Java Elasticsearch Java Client

client.ccr().resumeFollow(r -> r
    .index("follower_index")
    .maxOutstandingReadRequests(16L)
    .maxOutstandingWriteRequests(8L)
    .maxReadRequestOperationCount(1024L)
    .maxReadRequestSize("1024k")
    .maxRetryDelay(m -> m
        .time("10s")
    )
    .maxWriteBufferCount(512L)
    .maxWriteBufferSize("512k")
    .maxWriteRequestOperationCount(32768L)
    .maxWriteRequestSize("16k")
    .readPollTimeout(re -> re
        .time("30s")
    )
);

C# Elasticsearch .NET Client

var response = await client.CrossClusterReplication
    .ResumeFollowAsync(index: "follower_index", d1 => d1
        .MaxOutstandingReadRequests(16L)
        .MaxOutstandingWriteRequests(8L)
        .MaxReadRequestOperationCount(1024L)
        .MaxReadRequestSize("1024k")
        .MaxRetryDelay("10s")
        .MaxWriteBufferCount(512L)
        .MaxWriteBufferSize("512k")
        .MaxWriteRequestOperationCount(32768L)
        .MaxWriteRequestSize("16k")
        .ReadPollTimeout("30s")
    );

PHP Elasticsearch PHP Client

$resp = $client->ccr()->resumeFollow([
    "index" => "follower_index",
    "body" => [
        "max_read_request_operation_count" => 1024,
        "max_outstanding_read_requests" => 16,
        "max_read_request_size" => "1024k",
        "max_write_request_operation_count" => 32768,
        "max_write_request_size" => "16k",
        "max_outstanding_write_requests" => 8,
        "max_write_buffer_count" => 512,
        "max_write_buffer_size" => "512k",
        "max_retry_delay" => "10s",
        "read_poll_timeout" => "30s",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ccr.resume_follow(
  index: "follower_index",
  body: {
    "max_read_request_operation_count": 1024,
    "max_outstanding_read_requests": 16,
    "max_read_request_size": "1024k",
    "max_write_request_operation_count": 32768,
    "max_write_request_size": "16k",
    "max_outstanding_write_requests": 8,
    "max_write_buffer_count": 512,
    "max_write_buffer_size": "512k",
    "max_retry_delay": "10s",
    "read_poll_timeout": "30s"
  }
)

Response

A successful response from resuming a folower index.

{
  "acknowledged" : true
}