All Products
Search
Document Center

DataWorks:GetMigrationProcess

Last Updated:Oct 17, 2024

Queries the progress of 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

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

123456
MigrationIdlongYes

The migration package ID. You can call the CreateImportMigration operation to query the ID.

123456

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID.

SADFSDFSD-SDFSDF-XDXCVX-ESWW
ErrorMessagestring

The error message.

test error msg
Successboolean

Indicates whether the request was successful.

true
ErrorCodestring

The error code.

110001123456
Dataarray<object>

The progress information of the migration task, including the names of all steps in and status of the migration task.

ProgressTaskItemobject
TaskStatusstring

The running status of the step in the migration task. Valid values:

  • INIT
  • RUNNING
  • FAILURE
  • SUCCESS
SUCCESS
TaskNamestring

The name of the step in the migration task.

IMPORE_PREPARE

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "SADFSDFSD-SDFSDF-XDXCVX-ESWW",
  "ErrorMessage": "test error msg",
  "Success": true,
  "ErrorCode": "110001123456",
  "Data": [
    {
      "TaskStatus": "SUCCESS",
      "TaskName": "IMPORE_PREPARE"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history