Cancel or complete an RDS migration task with CloseDBClusterMigration - PolarDB - Alibaba Cloud - PolarDB

Operation description

Cancel the migration task before data migration.
Perform the migration task after data migration.

Note

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

Polardb:CloseDBClusterMigration

Update

*Dbcluster

Acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	String	Yes	The ID of the cluster.	Pc-**************
ContinueEnableBinlog	Boolean	No	Specifies whether to continue to enable binary logging. Valid values: True: continues to enable binary logging. False: disables binary logging. Default value: True. Note If binary logging is disabled, your PolarDB cluster is restarted.	True

Response elements

Element	Type	Description	Example
	Object
RequestId	String	The ID of the request.	3AA69096-757C-4647-B36C-29EBC2******

Examples

Success response

JSON format

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

Error response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	EngineMigrationStatus.NotSurpport	Specified engine migration status does not support.	The current engine migration status does not support this operation
400	EngineMigration.NotExist	Specified engine migration does not exist.	The instance is not in the engine migration state
404	InvalidDBClusterId.NotFound	The DBClusterId 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.