CloseEngineMigration - PolarDB - Alibaba Cloud Documentation Center

Closes the database engine migration process for a specified instance. After a user starts a data migration task from another database (such as a self-managed MySQL or ApsaraDB RDS instance) to PolarDB-X, this operation can be called to safely stop the migration process if the migration needs to be terminated or the migration state needs to be cleaned up.

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

polardbx:CloseEngineMigration

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceName	string	Yes	The instance name.	pxc-htri0****r4k9p
RegionId	string	No	The region ID.	cn-hangzhou
ContinueEnableBinlog	string	No	Specifies whether to keep binlog enabled. Valid values: true: Keeps binlog enabled. false: Disables binlog. Default value: true. Note Disabling binlog will restart your PolarDB cluster.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	C458B1E8-1683-3645-B154-6BA32080EEA
Code	string	The response code.	200
Message	string	The error message. This parameter is empty if the request is successful.	*****
HttpStatusCode	string	The HTTP status code.	200
SuccessResponse	string	Indicates whether the request is successful.	true
Data	object	The new endpoint connection string information.
DBInstanceName	string	The instance ID.	pxc-hzjasd****
TaskId	string	The backend task ID.	2209883

Examples

Success response

JSON format

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Code": "200",
  "Message": "*****",
  "HttpStatusCode": "200",
  "SuccessResponse": "true",
  "Data": {
    "DBInstanceName": "pxc-hzjasd****",
    "TaskId": "2209883"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.