All Products
Search
Document Center

Data Online Migration:GetReport

Last Updated:Jun 16, 2025

Obtains the details of a migration report.

Operation description

  • To query the information about a migration report, you must have the permission on mgw:GetImportReport.
  • The migration report is pushed to the destination data address. For more information, see the "View a migration report" section of the "Subsequent operations" topic in migration tutorials.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /report HTTP/1.1 Host: userid.cn-hangzhou.mgw.aliyuncs.com

Request parameters

ParameterTypeRequiredDescriptionExample
versionstringYes

The ID of the migration task.

test_job_id
runtimeIdstringNo

The execution ID of the migration task.

1

Response parameters

ParameterTypeDescriptionExample
object

The response body.

GetReportResponseGetReportResp

The details for obtaining the migration report.

Examples

Sample success responses

JSONformat

{
  "GetReportResponse": {
    "Status": "Running",
    "ReportCreateTime": "2024-05-01 12:00:00",
    "ReportEndTime": "2024-05-01 12:00:00",
    "TotalCount": 1000,
    "CopiedCount": 800,
    "SkippedCount": 100,
    "FailedCount": 100,
    "JobCreateTime": "2024-05-01 12:00:00",
    "JobEndTime": "2024-05-01 12:00:00",
    "JobExecuteTime": 1000,
    "TotalListPrefix": "test_total_prefix/",
    "SkippedListPrefix": "test_skipped_prefix/",
    "FailedListPrefix": "test_failed_prefix/",
    "ErrorMessage": "test error msg."
  }
}

XMLformat

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetReportResponse>
  <Status>Running</Status>
  <ReportCreateTime>2024-05-01 12:00:00</ReportCreateTime>
  <ReportEndTime>2024-05-01 12:00:00</ReportEndTime>
  <TotalCount>1000</TotalCount>
  <CopiedCount>800</CopiedCount>
  <SkippedCount>100</SkippedCount>
  <FailedCount>100</FailedCount>
  <JobCreateTime>2024-05-01 12:00:00</JobCreateTime>
  <JobEndTime>2024-05-01 12:00:00</JobEndTime>
  <JobExecuteTime>1000</JobExecuteTime>
  <TotalListPrefix>test_total_prefix/</TotalListPrefix>
  <SkippedListPrefix>test_skipped_prefix/</SkippedListPrefix>
  <FailedListPrefix>test_failed_prefix/</FailedListPrefix>
  <ErrorMessage>test error msg.</ErrorMessage>
</GetReportResponse>

Error codes

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