mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-13 08:25:26 +00:00
82 lines
2.5 KiB
Plaintext
82 lines
2.5 KiB
Plaintext
|
[role="xpack"]
|
||
|
|
[testenv="platinum"]
|
||
|
|
[[ccr-pause-auto-follow-pattern]]
|
||
|
|
=== Pause auto-follow pattern API
|
||
|
|
++++
|
||
|
|
<titleabbrev>Pause auto-follow pattern</titleabbrev>
|
||
|
|
++++
|
||
|
|
|
||
|
|
Pauses an auto-follow pattern.
|
||
|
|
|
||
|
|
[[ccr-pause-auto-follow-pattern-request]]
|
||
|
|
==== {api-request-title}
|
||
|
|
|
||
|
|
`POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause`
|
||
|
|
|
||
|
|
[[ccr-pause-auto-follow-pattern-prereqs]]
|
||
|
|
==== {api-prereq-title}
|
||
|
|
|
||
|
|
* If the {es} {security-features} are enabled, you must have `manage_ccr` cluster
|
||
|
|
privileges on the cluster that contains the follower index. For more information,
|
||
|
|
see <<security-privileges>>.
|
||
|
|
|
||
|
|
[[ccr-pause-auto-follow-pattern-desc]]
|
||
|
|
==== {api-description-title}
|
||
|
|
|
||
|
|
This API pauses an <<ccr-auto-follow,auto-follow pattern>>. When this API returns, the auto-follow pattern
|
||
|
|
is inactive and ignores any new index created on the remote cluster that matches any of
|
||
|
|
the auto-follow's patterns. Paused auto-follow patterns appear with the `active` field
|
||
|
|
set to `false` in the <<ccr-get-auto-follow-pattern, GET auto-follow patterns API>>.
|
||
|
|
|
||
|
|
You can resume auto-following with the <<ccr-resume-auto-follow-pattern,resume auto-follow pattern API>>.
|
||
|
|
Once resumed, the auto-follow pattern is active again and automatically configure
|
||
|
|
follower indices for newly created indices on the remote cluster that match its patterns.
|
||
|
|
Remote indices created while the
|
||
|
|
pattern was paused will also be followed, unless they have been deleted or closed in the
|
||
|
|
meantime.
|
||
|
|
|
||
|
|
[[ccr-pause-auto-follow-pattern-path-parms]]
|
||
|
|
==== {api-path-parms-title}
|
||
|
|
|
||
|
|
`<auto_follow_pattern_name>`::
|
||
|
|
(Required, string) Name of the auto-follow pattern to pause.
|
||
|
|
|
||
|
|
|
||
|
|
[[ccr-pause-auto-follow-pattern-examples]]
|
||
|
|
==== {api-examples-title}
|
||
|
|
|
||
|
|
This example pauses an auto-follow pattern named `my_auto_follow_pattern`:
|
||
|
|
//////////////////////////
|
||
|
|
|
||
|
|
[source,console]
|
||
|
|
--------------------------------------------------
|
||
|
|
PUT /_ccr/auto_follow/my_auto_follow_pattern
|
||
|
|
{
|
||
|
|
"remote_cluster" : "remote_cluster",
|
||
|
|
"leader_index_patterns" :
|
||
|
|
[
|
||
|
|
"leader_index"
|
||
|
|
],
|
||
|
|
"follow_index_pattern" : "{{leader_index}}-follower"
|
||
|
|
}
|
||
|
|
--------------------------------------------------
|
||
|
|
// TEST[setup:remote_cluster]
|
||
|
|
// TESTSETUP
|
||
|
|
|
||
|
|
//////////////////////////
|
||
|
|
|
||
|
|
[source,console]
|
||
|
|
--------------------------------------------------
|
||
|
|
POST /_ccr/auto_follow/my_auto_follow_pattern/pause
|
||
|
|
--------------------------------------------------
|
||
|
|
// TEST
|
||
|
|
|
||
|
|
The API returns the following result:
|
||
|
|
|
||
|
|
[source,console-result]
|
||
|
|
--------------------------------------------------
|
||
|
|
{
|
||
|
|
"acknowledged" : true
|
||
|
|
}
|
||
|
|
--------------------------------------------------
|