doc-exports/docs/rds/api-ref/rds_05_0014.html
Wang , Deng Ke 21e968a153 rds api 2.0.38sp24 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-01-12 13:50:31 +00:00

13 KiB

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

Response

  • Normal response

    Name

    Description

    workflowId

    Indicates the workflow ID.

    For details about how to query this parameter, see Obtaining Task Information.

    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

Error Code

For details, see Error Codes.