All Products
Search
Document Center

PolarDB:ModifyDBClusterMigration

Last Updated:Nov 07, 2023

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

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:ModifyDBClusterMigrationWRITE
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of cluster.

pc-**************
SourceRDSDBInstanceIdstringYes

The ID of the source ApsaraDB RDS instance.

rm-************
NewMasterInstanceIdstringYes

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-**************
SwapConnectionStringstringNo

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
ConnectionStringsstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

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 codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
2023-09-12The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 404 change
    Added Error Codes: 400
2022-07-27The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 404
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: ConnectionStrings