mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-01 16:39:11 +00:00
fdfdbe486d
This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
76 lines
1.8 KiB
Plaintext
76 lines
1.8 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ccr-post-unfollow]]
|
|
=== Unfollow API
|
|
++++
|
|
<titleabbrev>Unfollow</titleabbrev>
|
|
++++
|
|
|
|
Converts a follower index to a regular index.
|
|
|
|
==== Description
|
|
|
|
This API stops the following task associated with a follower index and removes
|
|
index metadata and settings associated with {ccr}. This enables the index to
|
|
treated as a regular index. The follower index must be paused and closed before
|
|
invoking the unfollow API.
|
|
|
|
NOTE: Currently {ccr} does not support converting an existing regular index to a
|
|
follower index. Converting a follower index to a regular index is an
|
|
irreversible operation.
|
|
|
|
==== Request
|
|
|
|
//////////////////////////
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT /follower_index/_ccr/follow
|
|
{
|
|
"remote_cluster" : "remote_cluster",
|
|
"leader_index" : "leader_index"
|
|
}
|
|
|
|
POST /follower_index/_ccr/pause_follow
|
|
|
|
POST /follower_index/_close
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TESTSETUP
|
|
// TEST[setup:remote_cluster_and_leader_index]
|
|
|
|
//////////////////////////
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /<follower_index>/_ccr/unfollow
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[s/<follower_index>/follower_index/]
|
|
|
|
==== Path Parmeters
|
|
|
|
`follower_index` (required)::
|
|
(string) the name of the follower index
|
|
|
|
==== Example
|
|
|
|
This example converts `follower_index` from a follower index to a regular index:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /follower_index/_ccr/unfollow
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST
|
|
|
|
The API returns the following result:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged" : true
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE
|