GetMigrationProcess

Updated at:

Queries the progress of a migration task.

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 workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.

123456

MigrationId

integer

Yes

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

123456

Response elements

Element

Type

Description

Example

object

The response parameters.

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The request ID.

SADFSDFSD-SDFSDF-XDXCVX-ESWW

ErrorMessage

string

The error message.

test error msg

Success

boolean

Indicates whether the request was successful.

true

ErrorCode

string

The error code.

110001123456

Data

array<object>

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

object

The returned task status.

TaskStatus

string

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

  • INIT: initial state

  • RUNNING: running

  • FAILURE: failed

  • SUCCESS: successful

SUCCESS

TaskName

string

The name of the step in the migration task.

IMPORE_PREPARE

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.