All Products
Search
Document Center

DataWorks:StartMigration

Last Updated:Oct 17, 2024

Starts 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 obtain the workspace ID.

123456
MigrationIdlongYes

The migration package ID. You can call the CreateImportMigration operation to query the ID of the import package and call the CreateExportMigration operation to query the ID of the export package.

123456

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
Databoolean

Indicates whether the migration task is started. Valid values:

  • true: The migration task is started.
  • false: The migration task fails to be started.
true
ErrorMessagestring

The error message.

test error msg
RequestIdstring

The request ID.

FSDFSDF-WERWER-XVCX-DSFSDF
ErrorCodestring

The error code.

110001123445
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "test error msg",
  "RequestId": "FSDFSDF-WERWER-XVCX-DSFSDF",
  "ErrorCode": "110001123445",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history