Stop database traffic requests
REST API requests to stop traffic for a database
| Method | Path | Description |
|---|---|---|
| POST | /v1/bdbs/{uid}/actions/stop_traffic |
Stop database traffic |
Stop database traffic
POST /v1/bdbs/{int: uid}/actions/stop_traffic
Stop handling traffic for the database.
Use this action to stop read and write traffic on a database. To resume traffic afterward, use the resume_traffic action.
Required permissions
| Permission name | Roles |
|---|---|
| update_bdb_with_action | admin cluster_member db_member |
Request
Example HTTP request
POST /bdbs/1/actions/stop_traffic
URL parameters
| Field | Type | Description |
|---|---|---|
| uid | integer | The unique ID of the database. |
Response
Returns a JSON object with an action_uid. You can track the action's progress with a GET /v1/actions/<action_uid> request.
Status codes
| Code | Description |
|---|---|
| 200 OK | The request is accepted and is being processed. The database state will be active-change-pending until the request has been fully processed. |
| 404 Not Found | Attempting to perform an action on a nonexistent database. |
| 409 Conflict | Attempting to change a database while it is busy with another configuration change. This is a temporary condition, and the request should be reattempted later. |