ModifyDBClusterMigration - PolarDB

Switches or rolls back the task that migrates data from an ApsaraDB for RDS instance to a PolarDB cluster.

Operation description

You can call this operation to switch the task that migrates data from ApsaraDB for RDS to PolarDB.
You can call this operation to roll back the task that migrates data from ApsaraDB for RDS to PolarDB.

Note Before you call this operation, ensure that a one-click upgrade task has been created for the cluster. You can call the CreateDBCluster operation to create an upgrade task. Set the CreationOption parameter to MigrationFromRDS. For more information, see Create a PolarDB for MySQL cluster by using the Migration from RDS method.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:ModifyDBClusterMigration	Write	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of cluster.	pc-**************
SourceRDSDBInstanceId	string	Yes	The ID of the source ApsaraDB RDS instance.	rm-************
NewMasterInstanceId	string	Yes	The ID of the new instance or new cluster. Valid values: To perform a data migration, enter the ID of the PolarDB cluster. To perform a migration rollback, enter the ID of the ApsaraDB for RDS instance.	pc-**************
SwapConnectionString	string	No	Specifies whether to switch the endpoints. Valid values: true: switches the endpoints. If you select this option, you do not need the change the endpoint in your applications. false: does not switch the endpoints. If you select this option, you must specify the endpoint of the PolarDB cluster in your applications. Default value: false.	false
ConnectionStrings	string	No	The endpoints to be switched. The endpoints are in the JSON format. Note This parameter is valid when the SwapConnectionString parameter 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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	A1B303A5-653F-4AEE-A598-023FF9******

Examples

Sample success responses

JSONformat

{
  "RequestId": "A1B303A5-653F-4AEE-A598-023FF9******"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-09-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change
	Added Error Codes: 400

2022-07-27

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 404
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ConnectionStrings