ListMigrations - DataWorks - Alibaba Cloud Documentation Center

Queries a list of migration tasks.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.	12345
MigrationType	string	Yes	The migration task type. Valid values: IMPORT and EXPORT.	IMPORT
Owner	string	No	The owner ID.	193379****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F9198AA3-9010-53D5-9714-DC4461427D3E
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The returned data.
Migrations	array<object>	The list of migration tasks.
Migration	object
Id	long	The primary key ID.	436064
Name	string	The name of the migration task.	test_task_1638498642279
PackageType	string	The type of the import or export package. Valid values: DWMA (standard format) DATAWORKS_MODEL (standard format) DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11) DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later) The DWMA and DATAWORKS_MODEL types are interchangeable.	DATAWORKS_MODEL
MigrationType	string	The type of the migration task. IMPORT EXPORT	EXPORT
CreateTime	long	The time when the migration task was created.	123124123123123
UpdateTime	long	The time when the migration task was last updated.	123123123123123
CreateUser	string	The ID of the user who created the migration task.	123123****
CreateUserName	string	The name of the user who created the migration task.	3h1_test
UpdateUser	string	The ID of the user who last updated the migration task.	1231****
UpdateUserName	string	The name of the user who last updated the migration task.	3h1_test
ProjectId	long	The ID of the DataWorks workspace to which the task belongs.	72132
TenantId	long	The tenant ID.	16307
Status	string	The status of the migration task. Valid values: INIT: The migration task is in the initial state. EDITING: The migration task is being edited. RUNNING: The migration task is running. FAILURE: The migration task fails to run. SUCCESS: The migration task is successfully run.	SUCCESS
Message	string	The error message returned.	An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it
DownloadUrl	string	The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.	http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx
Description	string	The description of the export task.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 50.	10
TotalCount	integer	The total number of entries.	20

Examples

Sample success responses

JSONformat

{
  "RequestId": "F9198AA3-9010-53D5-9714-DC4461427D3E",
  "Success": true,
  "Data": {
    "Migrations": [
      {
        "Id": 436064,
        "Name": "test_task_1638498642279",
        "PackageType": "DATAWORKS_MODEL",
        "MigrationType": "EXPORT",
        "CreateTime": 123124123123123,
        "UpdateTime": 123123123123123,
        "CreateUser": "123123****",
        "CreateUserName": "3h1_test",
        "UpdateUser": "1231****",
        "UpdateUserName": "3h1_test",
        "ProjectId": 72132,
        "TenantId": 16307,
        "Status": "SUCCESS",
        "Message": "An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it",
        "DownloadUrl": "http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx",
        "Description": ""
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history