GetMigrationSummary

Queries the details of an import or export migration task, including task status, creator, and download URL.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can obtain the ID on the Workspace page in the DataWorks console.	12345
MigrationId	integer	Yes	The migration task ID. Call CreateImportMigration to obtain an import task ID, or CreateExportMigration to obtain an export task ID.	1234

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, used for log queries and troubleshooting.	19999A96-71BA-2845-B455-ED620EF4E37F
Success	boolean	Whether the request was successful. Valid values: true false	true
Data	object	The details of the migration task.
MigrationId	integer	The task ID.	1234
Name	string	The task name.	test_export_01
GmtCreate	integer	The time when the task was created.	1589904000000
GmtModified	integer	The time when the task was modified.	1589904000000
CreateUser	string	The ID of the user who created the task.	982293332403****
OpUser	string	The ID of the user who managed the task.	982293332403****
Status	string	The migration task status. Valid values: INIT EDITING IMPORTING IMPORT_ERROR IMPORT_SUCCESS EXPORTING EXPORT_ERROR EXPORT_SUCCESS REVOKED PARTIAL_SUCCESS	EXPORT_SUCCESS
ProjectId	integer	The DataWorks workspace ID of the migration task.	12345
DownloadUrl	string	The download URL for the export task package.	https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx

Examples

Success response

JSON format

{
  "RequestId": "19999A96-71BA-1845-B455-ED620EF4E37F",
  "Success": true,
  "Data": {
    "MigrationId": 1234,
    "Name": "test_export_01",
    "GmtCreate": 1589904000000,
    "GmtModified": 1589904000000,
    "CreateUser": "982293332403****",
    "OpUser": "982293332403****",
    "Status": "EXPORT_SUCCESS",
    "ProjectId": 12345,
    "DownloadUrl": "https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=****&Signature=qxxxxx"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.