Changing the Data Replication Mode of Primary/Standby DB Instances

Function

This API is used to change the data replication mode of primary/standby DB instances based on service requirements.

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 replication mode cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, changing instance class, creating users, or deleting users.
The replication mode in the request must be different from that of the DB instance. You can log in to the management console to view the replication mode of the DB instance. For details about how to change the replication mode, see Changing the Replication Mode.

URI

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

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
mode	Yes	String	Specifies the replication mode. For RDS for MySQL, the value can be any of the following: async: asynchronous semisync: semi-synchronous For RDS for PostgreSQL, the value can be any of the following: async: asynchronous sync: synchronous

Example Request

Change the replication mode of a primary/standby DB instance to asynchronous.

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

{
    "mode": "async"
}

Response

Normal response

Name	Description
workflowId	Indicates the workflow ID.
instanceId	Indicates the DB instance ID.
replicationMode	Indicates the replication mode.

Example normal response

{
    "instanceId": "c8a7d0abe94840dda99bc437e9442982in01",
    "replicationMode": "async",
    "workflowId": "7b55d6ca-dc8e-4844-a9da-6c53a1506db3"
}