104 lines
3.0 KiB
Plaintext
104 lines
3.0 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ccr-post-resume-follow]]
|
|
=== Resume follower API
|
|
++++
|
|
<titleabbrev>Resume follower</titleabbrev>
|
|
++++
|
|
|
|
Resumes a follower index.
|
|
|
|
[[ccr-post-resume-follow-request]]
|
|
==== {api-request-title}
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT /follower_index/_ccr/follow?wait_for_active_shards=1
|
|
{
|
|
"remote_cluster" : "remote_cluster",
|
|
"leader_index" : "leader_index"
|
|
}
|
|
|
|
POST /follower_index/_ccr/pause_follow
|
|
--------------------------------------------------
|
|
// TESTSETUP
|
|
// TEST[setup:remote_cluster_and_leader_index]
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /follower_index/_ccr/pause_follow
|
|
--------------------------------------------------
|
|
// TEARDOWN
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /<follower_index>/_ccr/resume_follow
|
|
{
|
|
}
|
|
--------------------------------------------------
|
|
// TEST[s/<follower_index>/follower_index/]
|
|
// TEST[s/<remote_cluster>/remote_cluster/]
|
|
// TEST[s/<leader_index>/leader_index/]
|
|
|
|
[[ccr-post-resume-follow-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have `write` and `monitor`
|
|
index privileges for the follower index. You must have `read` and `monitor`
|
|
index privileges for the leader index. You must also have `manage_ccr` cluster
|
|
privileges on the cluster that contains the follower index. For more information,
|
|
see {stack-ov}/security-privileges.html[Security privileges].
|
|
|
|
[[ccr-post-resume-follow-desc]]
|
|
==== {api-description-title}
|
|
|
|
This API resumes a follower index that has been paused either explicitly with
|
|
the <<ccr-post-pause-follow, pause follower API>> or implicitly due to
|
|
execution that can not be retried due to failure during following. When this API
|
|
returns, the follower index will resume fetching operations from the leader index.
|
|
|
|
[[ccr-post-resume-follow-path-parms]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<follower_index>`::
|
|
(Required, string) The name of the follower index.
|
|
|
|
[[ccr-post-resume-follow-request-body]]
|
|
==== {api-request-body-title}
|
|
include::../follow-request-body.asciidoc[]
|
|
|
|
[[ccr-post-resume-follow-examples]]
|
|
==== {api-examples-title}
|
|
|
|
This example resumes a follower index named `follower_index`:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
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"
|
|
}
|
|
--------------------------------------------------
|
|
|
|
The API returns the following result:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged" : true
|
|
}
|
|
--------------------------------------------------
|