69 lines
1.6 KiB
Plaintext
69 lines
1.6 KiB
Plaintext
|
[role="xpack"]
|
||
|
|
[testenv="platinum"]
|
||
|
|
[[ccr-post-pause-follow]]
|
||
|
|
=== Pause Follower API
|
||
|
|
++++
|
||
|
|
<titleabbrev>Pause Follower</titleabbrev>
|
||
|
|
++++
|
||
|
|
|
||
|
|
Pauses a follower index.
|
||
|
|
|
||
|
|
==== Description
|
||
|
|
|
||
|
|
This API pauses a follower index. When this API returns, the follower index will
|
||
|
|
not fetch any additional operations from the leader index. You can resume
|
||
|
|
following with the <<ccr-post-resume-follow,resume follower API>>. Pausing and
|
||
|
|
resuming a follower index can be used to change the configuration of the
|
||
|
|
following task.
|
||
|
|
|
||
|
|
==== Request
|
||
|
|
|
||
|
|
//////////////////////////
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
--------------------------------------------------
|
||
|
|
PUT /follower_index/_ccr/follow
|
||
|
|
{
|
||
|
|
"remote_cluster" : "remote_cluster",
|
||
|
|
"leader_index" : "leader_index"
|
||
|
|
}
|
||
|
|
--------------------------------------------------
|
||
|
|
// CONSOLE
|
||
|
|
// TESTSETUP
|
||
|
|
// TEST[setup:remote_cluster_and_leader_index]
|
||
|
|
|
||
|
|
//////////////////////////
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
--------------------------------------------------
|
||
|
|
POST /<follower_index>/_ccr/pause_follow
|
||
|
|
--------------------------------------------------
|
||
|
|
// CONSOLE
|
||
|
|
// TEST[s/<follower_index>/follower_index/]
|
||
|
|
|
||
|
|
==== Path Parameters
|
||
|
|
|
||
|
|
`follower_index` (required)::
|
||
|
|
(string) the name of the follower index
|
||
|
|
|
||
|
|
==== Example
|
||
|
|
|
||
|
|
This example pauses a follower index named `follower_index`:
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
--------------------------------------------------
|
||
|
|
POST /follower_index/_ccr/pause_follow
|
||
|
|
--------------------------------------------------
|
||
|
|
// CONSOLE
|
||
|
|
// TEST
|
||
|
|
|
||
|
|
The API returns the following result:
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
--------------------------------------------------
|
||
|
|
{
|
||
|
|
"acknowledged" : true
|
||
|
|
}
|
||
|
|
--------------------------------------------------
|
||
|
|
// TESTRESPONSE
|