Migrating a Standby DB Instance

Function

This API is used to migrate a standby DB instance based on service requirements.

  • Before calling an API, you need to understand the API in Authentication.

  • Before calling this API, obtain the required region and endpoint.

Constraints

  • Only primary/standby DB instances running MySQL 5.6 or 5.7 support standby DB instance migration to another AZ.

  • The standby DB instance cannot be migrated if the primary DB instance is in any of the following statuses: creating, rebooting, upgrading, changing instance class, changing port, creating users, or deleting users.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/migrateslave

  • 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

    nodeId

    Yes

    String

    Specifies the ID of the standby node.

    azCode

    Yes

    String

    Specifies the code of the AZ to which the standby DB instance is to be migrated.

  • Request example

    POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/migrateslave
    
    {
        "nodeId": "0119b1068b874cb4a5202989a06b6094no01",
        "azCode": "az2xahz"
    }
    

Response

  • Normal response

    Name

    Description

    workflowId

    Indicates the task ID.

  • Example normal response

    {
        "workflowId":"7b55d6ca-dc8e-4844-a9da-6c53a1506db3"
    }
    
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.