Resume a follower

POST /{index}/_ccr/resume_follow

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

Path Parameters

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

Query Parameters

master_timeout string Duration · default: 30s: Period to wait for a connection to the master node.

Request

Response

application/json

Examples

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

Request Console 1 / 8 languages

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

{
  "acknowledged" : true
}

Path Parameters

Query Parameters

Request { max_outstanding_read_requests , max_outstanding_write_requests , max_read_request_operation_count , max_read_request_size , max_retry_delay , max_write_buffer_count , max_write_buffer_size , max_write_request_operation_count , max_write_request_size , read_poll_timeout , }

Response

Request