mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
e42c009884
This fixes the manage_follow_index builtin privilege so that it can be used for managing data streams in a follower cluster. In order to successfully unfollow a data stream the promote data stream and rollover APIs need to be executed. (This is additional to the close and unfollow APIs).
43 lines
1.3 KiB
Text
43 lines
1.3 KiB
Text
[role="xpack"]
|
|
[[promote-data-stream-api]]
|
|
=== Promote data stream API
|
|
++++
|
|
<titleabbrev>Promote data stream</titleabbrev>
|
|
++++
|
|
|
|
The purpose of the promote data stream api is to turn
|
|
a data stream that is replicated by CCR into a regular
|
|
data stream.
|
|
|
|
Via CCR Auto Following, a data stream from a remote cluster
|
|
can be replicated to the local cluster. These data streams
|
|
can't be rolled over in the local cluster. Only if the upstream
|
|
data stream rolls over then these replicated data streams roll
|
|
over as well. In the event that the remote cluster is no longer
|
|
available, the data stream in the local cluster can be promoted
|
|
to a regular data stream, which allows these data streams to
|
|
be rolled over in the local cluster.
|
|
|
|
[source,console]
|
|
----
|
|
POST /_data_stream/_promote/my-data-stream
|
|
----
|
|
// TEST[catch:missing]
|
|
|
|
[[promote-data-stream-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_data_stream/_promote/<data-stream>`
|
|
|
|
[[promote-data-stream-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage_follow_index`
|
|
<<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[promote-data-stream-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<data-stream>`::
|
|
(Required, string)
|
|
The name of the data stream to promote.
|