Skip to content

Commit ec77642

Browse files
committed
Feedback update to add failover REST API use case
1 parent 3f99787 commit ec77642

File tree

1 file changed

+4
-0
lines changed
  • content/operate/rs/references/rest-api/requests/shards/actions

1 file changed

+4
-0
lines changed

content/operate/rs/references/rest-api/requests/shards/actions/failover.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ weight: $weight
2222

2323
Performs failover on the primary shards specified by `shard_uids` in the request body, and promotes their replicas to primary shards. This request is asynchronous.
2424

25+
The cluster automatically manages failover to ensure high availability. Use this failover REST API request only for testing and planned maintenance.
26+
2527
#### Required permissions
2628

2729
| Permission name | Roles |
@@ -102,6 +104,8 @@ When errors are reported, the server may return a JSON object with `error_code`
102104

103105
Performs failover on the primary shard with the specified `shard_uid`, and promotes its replica shard to a primary shard. This request is asynchronous.
104106

107+
The cluster automatically manages failover to ensure high availability. Use this failover REST API request only for testing and planned maintenance.
108+
105109
#### Required permissions
106110

107111
| Permission name | Roles |

0 commit comments

Comments
 (0)