Help Center/ Relational Database Service/ API Reference (ME-Abu Dhabi Region)/ API v3 (Recommended)/ DB Instance Management/ Changing the Data Synchronize Model of Primary/Standby DB Instances
Updated on 2022-02-22 GMT+08:00

Changing the Data Synchronize Model of Primary/Standby DB Instances

Function

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

Constraints

  • This API is supported for MySQL only.
  • This API is supported for primary/standby DB instances only.
  • The synchronize model cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, changing instance class, creating users, or deleting users.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/failover/mode

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the 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

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    mode

    Yes

    String

    Specifies the synchronize model.

    For MySQL, the value can be any of the following:

    • async: asynchronous
    • semisync: semi-synchronous
  • Request example
    {
        "mode": "semisync"
    }

Response

  • Normal response

    Name

    Description

    workflowId

    Indicates the task ID.

    instanceId

    Indicates the DB instance ID.

    replicationMode

    Indicates the replication mode.

  • Example normal response
    {
        "instanceId": "c8a7d0abe94840dda99bc437e9442982in01",
        "replicationMode": "semisync",
        "workflowId": "7b55d6ca-dc8e-4844-a9da-6c53a1506db3"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.