GetMigrationSummary -

Queries the information about a migration task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	GetMigrationSummary	The operation that you want to perform.
RegionId	String	Yes	cn-shanghai	The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system determines the value of this parameter based on the endpoint that is used to call the operation.
ProjectId	Long	Yes	12345	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.
MigrationId	Long	Yes	1234	The ID of the migration task. 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.

Response parameters


Parameter	Type	Example	Description
RequestId	String	19999A96-71BA-1845-B455-ED620EF4E37F	The ID of the request. You can locate logs and troubleshoot issues based on the ID.
Success	Boolean	true	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails. You can locate the error based on the request ID.
Data	Object		The details of the migration task.
MigrationId	Long	1234	The ID of the migration task.
Name	String	test_export_01	The name of the migration task.
GmtCreate	Long	1589904000000	The time when the migration task was created.
GmtModified	Long	1589904000000	The time when the migration task was modified.
CreateUser	String	982293332403****	The ID of the user who creates the migration task.
OpUser	String	982293332403****	The ID of the user who manages the migration task.
Status	String	EXPORT_SUCCESS	The status of the migration task. Valid values: INIT: The migration task is initiating. EDITING: The migration task is being edited. IMPORTING: The migration task is importing data objects. IMPORT_ERROR: The migration task fails to import data objects. IMPORT_SUCCESS: Data objects are imported. EXPORTING: The migration task is exporting data objects. EXPORT_ERROR: The migration task fails to export data objects. EXPORT_SUCCESS: The migration task successfully exports data objects. REVOKED: The migration task is canceled. PARTIAL_SUCCESS: The migration task successfully imports or exports only some data objects.
ProjectId	Long	12345	The ID of the DataWorks workspace.
DownloadUrl	String	https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx	The URL that is used to download the package of the export task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMigrationSummary
&ProjectId=12345
&MigrationId=1234
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetMigrationSummaryResponse>
    <RequestId>19999A96-71BA-1845-B455-ED620EF4E37F</RequestId>
    <Success>true</Success>
    <Data>
        <MigrationId>1234</MigrationId>
        <Name>test_export_01</Name>
        <GmtCreate>1589904000000</GmtCreate>
        <GmtModified>1589904000000</GmtModified>
        <CreateUser>9822933324031844</CreateUser>
        <OpUser>9822933324031844</OpUser>
        <Status>EXPORT_SUCCESS</Status>
        <ProjectId>12345</ProjectId>
        <DownloadUrl>https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&amp;OSSAccessKeyId=XXXXXXeF4Lv5j&amp;Signature=qxxxxx</DownloadUrl>
    </Data>
</GetMigrationSummaryResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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&amp;OSSAccessKeyId=XXXXXXeF4Lv5j&amp;Signature=qxxxxx"
  }
}

Error codes

For a list of error codes, visit the API Error Center.