Migrating a Standby DB Instance

Function

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

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

Constraints

• This API is only available to RDS for MySQL and RDS for PostgreSQL.
• Primary/standby instances running MySQL 5.6, 5.7, or 8.0 support standby instance migration to another AZ. To migrate an RDS for MySQL 8.0 standby instance, contact customer service to apply for the required permissions.
• This API is supported for primary/standby DB instances only.
• 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 /v3/{project_id}/instances/{instance_id}/migrateslave

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	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

Example Request

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/migrateslave

{
	"nodeId": "0119b1068b874cb4a5202989a06b6094no01",
	"azCode": "az2"
}

Response

• Normal response

  Name	Description
  workflowId	Indicates the workflow ID.

• Example normal response

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

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.