ModifyEngineMigration - PolarDB - Alibaba Cloud Documentation Center

Operation description

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:ModifyEngineMigration

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DBInstanceName	string	No	The instance ID.	pxc-htri0****r4k9p
SourceDBInstanceName	string	No	The name of the source database instance.	source456
NewMasterDBInstanceName	string	No	The name of the new primary instance after the migration is complete.	newmaster789
SwapConnectionString	string	No	Specifies whether to automatically swap connection strings. Valid values: true: The application does not need to modify configurations. Connections are automatically directed to the new instance. false: You must manually update the application endpoint.	true
ConnectionStrings	string	No	The specific endpoints to switch. The value is a JSON string that corresponds to the endpoint pairs to be swapped. Note This parameter takes effect only when SwapConnectionString is set to true.	{\"pc-bp1m9tt23o5kh834y.rwlb.rds.aliyuncs.com\":\"rm-bp1ycl5o6ojs957o0.mysql.rds.aliyuncs.com\"}

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 additional information. The value success is returned if the request is successful. Otherwise, an error code is returned.	Success
HttpStatusCode	string	The HTTP status code.	200
SuccessResponse	string	Indicates whether the request was successful.	true
Data	object	The returned data.
DBInstanceName	string	The instance ID.	pxc-*********
TaskId	string	The task ID.	42292****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.