ListMigrationTask - Microservices Engine - Alibaba Cloud Documentation Center

This operation queries cloud migration tasks.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameters. This parameter is a JSON string.	{}
OriginInstanceName	string	No	The name of the source instance.	whdc
PageSize	integer	No	The number of entries per page.	10
PageNum	integer	No	The page number.	1
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	The data structure.
HttpCode	string	The HTTP status code.	200
Data	array<object>	The data array.
	object	The data structure.
Id	integer	The ID of the task.	1
UserId	string	The ID of the user.	2
ClusterType	string	The type of the cluster. Valid values: Nacos-Ans ZooKeeper Eureka	Nacos-Ans
OriginInstanceAddress	string	The endpoint of the source instance.	192.168.1.1:8848
OriginInstanceName	string	The name of the source instance.	test
OriginInstanceNamespace	string	The list of namespaces. This parameter is optional when the source instance is 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 time when the task was created.	2022-01-07T10:07:57.000+0000
GmtModified	string	The time when the task was updated.	2021-12-30T06:41:52.000+0000
SyncType	string	The synchronization type.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	2
RequestId	string	The ID of the request.	451EBE59-5F33-5B15-83C1-78593B9*****
Message	string	The returned message.	The request was successfully processed.
ErrorCode	string	The error code.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "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",
      "SyncType": ""
    }
  ],
  "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
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.