Updated on 2024-06-07 GMT+08:00

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 an API, you need to understand the API in Authentication.

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

    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

repairStrategy

Yes

String

Specifies the failover priority. Valid value:

  • 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.

Example Request

Change the failover priority of a DB instance to availability.

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

{
     "repairStrategy": "availability"
}

Response

  • Normal response

    None

Status Code

Error Code

For details, see Error Codes.