Cancels or completes the migration task that upgrades an RDS cluster to a PolarDB cluster.

  • Cancel the migration task before data migration.
  • Perform the migration task after data migration.
    Note Before you call this operation, make sure that an upgrade task for the cluster is created. You can call the CreateDBCluster operation to create an upgrade task. Set the CreationOption parameter to MigrationFromRDS. For more information, see Upgrade RDS for MySQL to PolarDB for MySQL.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringNoCloseDBClusterMigration

The operation that you want to perform. Set the value to CloseDBClusterMigration.

DBClusterIdStringYespc-**************

The ID of the cluster.

RegionIdStringNocn-hangzhou

The ID of the region.

ContinueEnableBinlogBooleanNotrue

Specifies whether to continue to enable binary logs. Valid values:

  • true: continues to enable binary logs.
  • false: disables binary logs.

Default value: true.

Note If binary logs are disabled, your PolarDB cluster is restarted.

Response parameters

ParameterTypeExampleDescription
RequestIdString3AA69096-757C-4647-B36C-29EBC2******

The ID of the request.

Examples

Sample request

http(s)://polardb.aliyuncs.com/? Action=CloseDBClusterMigration
&DBClusterId=pc-**************
&<Common request parameters>

Sample success responses

XML format

<CloseDBClusterMigrationResponse>  
  <RequestId>3AA69096-757C-4647-B36C-29EBC2******</RequestId>
</CloseDBClusterMigrationResponse>

JSON format

{    
  "RequestId": "3AA69096-757C-4647-B36C-29EBC2******"
  }

Error codes

For a list of error codes, visit the API Error Center.