Skip to content

Commit 9b36b6c

Browse files
committed
DOC-4035 Feedback update to add use cases for stop_traffic and resume_traffic actions
1 parent b73f9e2 commit 9b36b6c

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

content/operate/rs/references/rest-api/requests/bdbs/actions/resume_traffic.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ POST /v1/bdbs/{int: uid}/actions/resume_traffic
2323

2424
Resume traffic handling for the database.
2525

26+
Use this REST API request when implementing auto-failover or migrating data between Replica Of databases:
27+
28+
1. Use the [`stop_traffic`]({{<relref "/operate/rs/references/rest-api/requests/bdbs/actions/stop_traffic">}}) action on a Replica Of source database to ensure that no new data is written to it during data migration.
29+
30+
1. After data migration or failover is complete, and it is safe to write new data to the source database, use the `resume_traffic` action.
31+
2632
#### Required permissions
2733

2834
| Permission name | Roles |

content/operate/rs/references/rest-api/requests/bdbs/actions/stop_traffic.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ POST /v1/bdbs/{int: uid}/actions/stop_traffic
2323

2424
Stop handling traffic for the database.
2525

26+
Use this REST API request when implementing auto-failover or migrating data between Replica Of databases:
27+
28+
1. Use the `stop_traffic` action on a Replica Of source database to ensure that no new data is written to it during data migration.
29+
30+
1. After data migration or failover is complete, and it is safe to write new data to the source database, use the [`resume_traffic`]({{<relref "/operate/rs/references/rest-api/requests/bdbs/actions/resume_traffic">}}) action.
31+
2632
#### Required permissions
2733

2834
| Permission name | Roles |

0 commit comments

Comments
 (0)