ModifyDBClusterMigration
Switches or rolls back the migration task for a one-click upgrade from ApsaraDB RDS to PolarDB.
Operation description
If you call this operation before the switchover, a switchover is performed.
If you call this operation after the switchover is completed, a rollback is performed.
When you call this operation, a one-click upgrade task must have been created for the cluster. To create a one-click upgrade task, call the CreateDBCluster operation and set the CreationOption parameter to MigrationFromRDS. For more information, see Upgrade ApsaraDB RDS for MySQL to PolarDB for MySQL with one click.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
polardb:ModifyDBClusterMigration |
update |
*dbcluster
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DBClusterId |
string |
Yes |
The ID of the PolarDB cluster. |
pc-************** |
| SourceRDSDBInstanceId |
string |
Yes |
The instance ID of the source ApsaraDB RDS instance. |
rm-************ |
| NewMasterInstanceId |
string |
Yes |
Instance ID of the new instance or cluster. Valid values:
|
pc-************** |
| SwapConnectionString |
string |
No |
Specifies whether to switch the endpoint. Valid values:
Default value: false. |
false |
| ConnectionStrings |
string |
No |
The specific endpoints to be switched. The value is a JSON string that contains the endpoints to be swapped in pairs. Note
This parameter takes effect only when SwapConnectionString is set to true. |
{"rm-2ze73el581cs*****.mysql.pre.rds.aliyuncs.com":"pc-2ze8200s298e*****.mysql.polardb.pre.rds.aliyuncs.com","rm-2ze73el581cs86*****.mysql.pre.rds.aliyuncs.com":"test-p*****.mysql.polardb.pre.rds.aliyuncs.com"} |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The ID of the request. |
A1B303A5-653F-4AEE-A598-023FF9****** |
Examples
Success response
JSON format
{
"RequestId": "A1B303A5-653F-4AEE-A598-023FF9******"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidConnectionString.Malformed | The specified parameter ConnectionString is not valid. | The specified ConnectionString parameter is invalid. |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.