All Products
Search
Document Center

DataWorks:ListMigrations

Last Updated:Sep 04, 2025

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
dataworks:*none
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.

12345
MigrationTypestringYes

The migration task type. Valid values: IMPORT and EXPORT.

IMPORT
OwnerstringNo

The owner ID.

193379****
PageNumberintegerNo

The page number. Default value: 1. Maximum value: 100.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

F9198AA3-9010-53D5-9714-DC4461427D3E
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Dataobject

The returned data.

Migrationsarray<object>

The list of migration tasks.

Migrationobject

The migration task.

Idlong

The primary key ID.

436064
Namestring

The name of the migration task.

test_task_1638498642279
PackageTypestring

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
MigrationTypestring

The type of the migration task. Valid values:

  • IMPORT
  • EXPORT
EXPORT
CreateTimelong

The time when the migration task was created.

123124123123123
UpdateTimelong

The time when the migration task was last updated.

123123123123123
CreateUserstring

The ID of the user who created the migration task.

123123****
CreateUserNamestring

The name of the user who created the migration task.

3h1_test
UpdateUserstring

The ID of the user who last updated the migration task.

1231****
UpdateUserNamestring

The name of the user who last updated the migration task.

3h1_test
ProjectIdlong

The ID of the DataWorks workspace to which the task belongs.

72132
TenantIdlong

The tenant ID.

16307
Statusstring

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
Messagestring

The error message returned.

An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it
DownloadUrlstring

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
Descriptionstring

The description of the export task.

Automated Test creation
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page. Default value: 10. Maximum value: 50.

10
TotalCountinteger

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": "Automated Test creation" } ], "PageNumber": 1, "PageSize": 10, "TotalCount": 20 } }

Error codes

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

Change history

Change timeSummary of changesOperation
No change history