rds.instances.failoverPromote a replica and demote the current primary
POST /rds/api/instances/{id}/failoverIAM rds:FailoverDBInstanceChanges stateDestructive
Request syntax
POST /rds/api/instances/{id}/failoverPath parameters
idRequiredstring
Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/
Response
200 with { from }: the name of the node that was the leader.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Fields of data
fromAlwaysstring
Name of the node that led before the switchover
Checked against the handlers: every route test validates their answers against this schema.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow rds:FailoverDBInstance on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud rds instances failover idcurl -X POST "https://console.platform-development.deutschecloud.app/rds/api/instances/id/failover" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_instances_failover.