All Products
Search
Document Center

Microservices Engine:AddMigrationTask

Last Updated:Nov 20, 2024

Adds a migration task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:AddMigrationTaskcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RequestParsstringNo

The extended request parameters in the JSON format.

{}
ClusterTypestringNo

The type of the instance. Valid values:

  • Nacos-Ans
  • ZooKeeper
  • Eureka
Nacos-Ans
OriginInstanceAddressstringNo

The endpoint of the source instance node.

192.168.1.1:8848
OriginInstanceNamestringNo

The name of the source instance.

Source instance
OriginInstanceNamespacestringNo

The list of namespaces. This parameter is optional if you want to migrate applications from a Nacos instance.

namesapceId1,namesapceId2
TargetInstanceIdstringNo

The ID of the destination instance.

mse-cn-ud82*****
TargetClusterNamestringNo

The name of the destination instance.

Destination instance
TargetClusterUrlstringNo

The URL of the destination instance.

mse-66*****-nacos-ans.mse.aliyuncs.com:8848
ProjectDescstringNo

The description.

This is a description.
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

Dataobject

The data structure.

Idstring

The ID of the task.

12
UserIdstring

The ID of the user.

183876217*****
ClusterTypestring

The type of the instance. Valid values:

  • Nacos-Ans
  • ZooKeeper
  • Eureka
Nacos-Ans
OriginInstanceAddressstring

The endpoint of the source instance node.

192.168.1.1:8848
OriginInstanceNamestring

The name of the source instance.

Source instance
OriginInstanceNamespacestring

The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.

namesapceId1,namesapceId2
TargetInstanceIdstring

The ID of the destination instance.

mse-cn-7pp2w*****
TargetClusterNamestring

The name of the destination instance.

Destination instance
TargetClusterUrlstring

The URL of the destination instance.

mse-94d****-nacos-ans.mse.aliyuncs.com:8848
ProjectDescstring

The description.

testsdfsdfsd
RequestIdstring

The ID of the request.

7466566F-F30F-4A29-965D-3E0AF21D****
Messagestring

The message returned.

The request is processed successfully.
ErrorCodestring

The error code returned if the request failed.

mse-100-000
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-27The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-08-24The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-04-10The request parameters of the API has changed. The response structure of the API has changedView Change Details