Help Center/ Relational Database Service/ API Reference (Ankara Region)/ API v3 (Recommended)/ DB Instance Management/ Changing the Data Replication Mode of Primary/Standby DB Instances
Updated on 2024-04-11 GMT+08:00

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

URI

  • URI format

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

  • Example

    https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/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 replication mode.

    For MySQL, the value can be any of the following:
    • async: asynchronous
    • semisync: semi-synchronous
    For PostgreSQL, the value can be any of the following:
    • async: asynchronous
    • sync: synchronous
  • Request example
    {
        "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"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.