ListMigrationTask - Microservices Engine - Alibaba Cloud Documentation Center

Queries information about 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListMigrationTask	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameters in the JSON format.	{}
OriginInstanceName	string	No	The name of the source instance.	whdc
PageSize	long	No	The number of entries to return on each page.	10
PageNum	long	No	The number of the page to return.	1
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The data structure.
HttpCode	string	The HTTP status code returned.	200
Data	array<object>	The array structure.
data	object	The data structure.
Id	long	The ID of the job.	1
UserId	string	The ID of the user.	2
ClusterType	string	The type of the instance. 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.	test
OriginInstanceNamespace	string	The list of namespaces. This parameter is optional if applications are migrated from a Nacos instance.	fsdfsdfdsf
TargetInstanceId	string	The ID of the destination instance.	mse-cn-zv*****
TargetClusterName	string	The name of the destination instance.	multiple-nacos
TargetClusterUrl	string	The URL of the destination instance.	mse-f1******-nacos-ans.mse.aliyuncs.com:8848
ProjectDesc	string	The description.	test
GmtCreate	string	The creation time.	2022-01-07T10:07:57.000+0000
GmtModified	string	The update time.	2021-12-30T06:41:52.000+0000
PageSize	long	The number of entries returned per page.	10
PageNumber	long	The number of the returned page.	1
TotalCount	long	The total number of entries.	2
RequestId	string	The ID of the request.	451EBE59-5F33-5B15-83C1-78593B9*****
Message	string	The message returned.	The request was successfully processed.
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "HttpCode": "200",
  "Data": [
    {
      "Id": 1,
      "UserId": "2",
      "ClusterType": "Nacos-Ans",
      "OriginInstanceAddress": "192.168.1.1:8848",
      "OriginInstanceName": "test",
      "OriginInstanceNamespace": "fsdfsdfdsf",
      "TargetInstanceId": "mse-cn-zv*****",
      "TargetClusterName": "multiple-nacos",
      "TargetClusterUrl": "mse-f1******-nacos-ans.mse.aliyuncs.com:8848",
      "ProjectDesc": "test",
      "GmtCreate": "2022-01-07T10:07:57.000+0000",
      "GmtModified": "2021-12-30T06:41:52.000+0000"
    }
  ],
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 2,
  "RequestId": "451EBE59-5F33-5B15-83C1-78593B9*****",
  "Message": "The request was successfully processed.\n",
  "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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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

Change history

Change time	Summary of changes	Operation
2024-06-27	The response structure of the API has changed	View Change Details
2024-02-23	The internal configuration of the API is changed, but the call is not affected	View Change Details