GetMigrationSummary - DataWorks - Alibaba Cloud Documentation Center

Queries the 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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	none	All Resources ``	none	none

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
MigrationId	long	Yes	The migration task ID. You can call the CreateImportMigration operation to obtain the ID of the import task and call the CreateExportMigration operation to obtain the ID of the export task.	1234

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use the request ID to query logs and troubleshoot issues.	19999A96-71BA-2845-B455-ED620EF4E37F
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The details of the migration task.
MigrationId	long	The task ID.	1234
Name	string	The task name.	test_export_01
GmtCreate	long	The time when the task was created.	1589904000000
GmtModified	long	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 status of the migration task. Valid values: INIT EDITING IMPORTING IMPORT_ERROR IMPORT_SUCCESS EXPORTING EXPORT_ERROR EXPORT_SUCCESS REVOKED PARTIAL_SUCCESS	EXPORT_SUCCESS
ProjectId	long	The ID of the DataWorks workspace to which the migration task belongs.	12345
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.	https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx

Examples

Sample success responses

JSONformat

{ "RequestId": "19999A96-71BA-2845-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=XXXXXXeF4Lv5j&Signature=qxxxxx" } }

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history