All Products
Search
Document Center

DataWorks:StartMigration

Last Updated:Sep 18, 2024

Starts a migration task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*update
  • All Resources
    *
    none
none

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