Changing the Failover Priority

Function

This API is used to change the failover priority for primary/standby DB instances to meet different service requirements. You can select reliability or availability.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:modifyStrategy	permission_management	instance	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:modifyStrategy

permission_management

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

Constraints

This API is available to RDS for MySQL only.
This API is supported for primary/standby DB instances only.
The failover priority cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, creating users, or deleting users.

URI

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

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
repairStrategy	Yes	String	Definition Failover priority. Constraints N/A Range reliability: Data reliability is preferentially ensured during the failover to minimize the amount of lost data. It is recommended for services that require high data consistency. availability: Data availability is preferentially ensured during the failover to recover services quickly. It is recommended for services that have high requirements on the database online duration. Default Value N/A

Example Request

Change the failover priority of a DB instance to availability.

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

{
     "repairStrategy": "availability"
}