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 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:modifySynchronizeModel	permission_management	instance	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:modifySynchronizeModel

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 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	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
mode	Yes	String	Definition Replication mode. Constraints N/A Range 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 Default Value N/A

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

Parameter	Description
workflowId	Definition Indicates the workflow ID. Range N/A
instanceId	Definition Indicates the DB instance ID. Range N/A
replicationMode	Definition Indicates the replication mode. Range N/A

Parameter

Description

workflowId

Definition

Indicates the workflow ID.

Range

N/A

instanceId

Definition

Indicates the DB instance ID.

Range

N/A

replicationMode

Definition

Indicates the replication mode.

Range

N/A

Example normal response

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