Manually Switching Primary/Standby DB Instances

Function

This API is used to manually switch primary/standby DB instances as required.

Before calling an API, you need to understand the API in Authentication.

Constraints

This API is supported for primary/standby DB instances only.
This operation cannot be performed if the DB instance is in any of the following statuses: creating, rebooting, upgrading, changing instance class, restoring, changing port, deleting database account, or creating database account.
The primary/standby switchover does not change the floating IP address of your instance.

URI

URI format
PUT /v3/{project_id}/instances/{instance_id}/failover

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	Specifies the DB instance ID.

Request

**Table 2** Parameter description
Name	Mandatory	Type	Description
force	No	Boolean	Whether to perform a forcible primary/standby switchover. By default, this parameter is left blank, indicating that the switchover is not performed forcibly. true: A forcible switchover is performed. false: No forcible switchover is performed. NOTE: This parameter is valid only for the PostgreSQL DB engine.

Example Request

Perform a primary/standby switchover.

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover

{}

Perform a forcible primary/standby switchover.
```
{
"force":true
}
```

Response

Normal response

Name	Description
workflowId	Indicates the workflow ID.
instanceId	Indicates the DB instance ID.
nodeId	Indicates the node ID.

Example normal response

{
    "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a",
    "instanceId":"794c38e5309344818f4b33b86ebce9b4in03",
    "nodeId":"b94ba815747040f1b0d641cd13364a06no03"
}