Use AddMigrationTask to create a migration task - Microservices Engine - Alibaba Cloud - Microservices Engine

Creates a migration task.

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

mse:AddMigrationTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameters in JSON format.	{}
ClusterType	string	No	The cluster type. Valid values: Nacos-Ans ZooKeeper Eureka	Nacos-Ans
OriginInstanceAddress	string	No	The address of the source instance node.	192.168.1.1:8848
OriginInstanceName	string	No	The name of the source instance.	Source cluster
OriginInstanceNamespace	string	No	The list of namespaces. This parameter is optional when the source cluster is Nacos.	namesapceId1,namesapceId2
TargetInstanceId	string	No	The instance ID of the target instance.	mse-cn-ud82*****
TargetClusterName	string	No	The name of the target instance.	Target cluster
TargetClusterUrl	string	No	The URL of the target instance.	mse-66*****-nacos-ans.mse.aliyuncs.com:8848
ProjectDesc	string	No	The description.	This is a description.
SyncType	string	No	The synchronization type. Valid values: configuration synchronization, service synchronization, or full synchronization. Valid values: All : All Config : Config Service : Service	Service
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The data structure.
Data	object	The data structure.
Id	string	The ID of the task.	12
UserId	string	The ID of the user.	183876217*****
ClusterType	string	The cluster type. Valid values: Nacos-Ans ZooKeeper Eureka	Nacos-Ans
OriginInstanceAddress	string	The address of the source instance node.	192.168.1.1:8848
OriginInstanceName	string	The name of the source instance.	Source cluster
OriginInstanceNamespace	string	The list of namespaces. This parameter is optional when the source cluster is Nacos.	namesapceId1,namesapceId2
TargetInstanceId	string	The instance ID of the target instance.	mse-cn-7pp2w*****
TargetClusterName	string	The name of the target instance.	Target cluster
TargetClusterUrl	string	The URL of the target instance.	mse-94d****-nacos-ans.mse.aliyuncs.com:8848
ProjectDesc	string	The description.	testsdfsdfsd
SyncType	string	The synchronization type.	Service
RequestId	string	The ID of the request.	7466566F-F30F-4A29-965D-3E0AF21D****
Message	string	The message.	The request is processed successfully.
ErrorCode	string	The error code.	mse-100-000
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "Data": {
    "Id": "12",
    "UserId": "183876217*****",
    "ClusterType": "Nacos-Ans",
    "OriginInstanceAddress": "192.168.1.1:8848\n",
    "OriginInstanceName": "Source cluster",
    "OriginInstanceNamespace": "namesapceId1,namesapceId2",
    "TargetInstanceId": "mse-cn-7pp2w*****",
    "TargetClusterName": "Target cluster",
    "TargetClusterUrl": "mse-94d****-nacos-ans.mse.aliyuncs.com:8848",
    "ProjectDesc": "testsdfsdfsd",
    "SyncType": "Service"
  },
  "RequestId": "7466566F-F30F-4A29-965D-3E0AF21D****",
  "Message": "The request is processed successfully.",
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.