All Products
Search

This Product

    Data Transmission Service:Query the status of a data migration task

    Document Center

    Data Transmission Service:Query the status of a data migration task

    Last Updated:Nov 11, 2025

    This topic describes how to query the status of a data migration task using a legacy API operation.

    Test

    You can call this operation directly in OpenAPI Explorer. This eliminates the need to calculate signatures. After a successful call, OpenAPI Explorer automatically generates sample code for various software development kits (SDKs).

    Request parameters

    Parameter

    Type

    Required

    Example

    Description
    Action String Yes DescribeMigrationJobStatus

    A required parameter. Set the value to DescribeMigrationJobStatus.
    RegionId String No cn-hangzhou

    The ID of the region where the data migration instance resides. For more information, see Supported regions.
    MigrationJobId String Yes dtsxxxxxxxx

    The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the instance ID.
    ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxxxxx

    A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length.
    AccountId String No 12323344****

    The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter is scheduled to be deprecated.
    ResourceGroupId String No rg-acfmzawhxxc****

    The ID of the resource group.

    Response parameters

    Parameter

    Type

    Example

    Description
    RequestId String A032E3B4-929B-48E9-97B9-37587CBF****

    The ID of the request.
    MigrationJobName String MySQL Migration

    The name of the data migration instance.
    MigrationJobStatus String Migrating

    The status of the data migration task. Valid values:

    • NotStarted: The task is not started.
    • Prechecking: The task is being prechecked.
    • PrecheckFailed: The task failed the precheck.
    • Migrating: The task is migrating data.
    • Suspending: The task is paused.
    • MigrationFailed: The task failed to migrate data.
    • Finished: The task is complete.
    ErrCode String InternalError

    The error code returned if the call fails.
    Success String true

    Indicates whether the call was successful.
    PayType String PostPaid

    The billing method of the data migration task. The value is fixed as PostPaid, which indicates the pay-as-you-go billing method.
    ErrMessage String The request processing has failed due to some unknown error.

    The error message returned if the call fails.
    MigrationObject String [{\"DBName\":\"dtstestdata\",\"TableIncludes\":[{\"TableName\":\"customer\"}]}]

    The objects that are migrated.
    MigrationJobId String dtsxxxxxxxx

    The ID of the data migration instance.
    TaskId String z2v12jfo309****

    The ID of the data migration task.
    MigrationJobClass String 2xlarge

    The specifications of the data migration instance. Valid values: small, medium, large, xlarge, and 2xlarge. For more information, see Specifications of data migration instances.
    DataInitializationStatus Object

    The status of initial full data synchronization.
    Status String Finished

    The status of initial full data synchronization. Valid values:

    • NotStarted: Not started.
    • Migrating: In progress.
    • Failed: Failed.
    • Finished: Complete.
    Percent String 100

    The progress of initial full data synchronization. Unit: percentage.
    ErrorMessage String java.lang.NumberFormatException: For input string: ""

    The error message returned if initial full data synchronization fails.
    Progress String 200001

    The number of records that have been synchronized during initial full data synchronization.
    DataSynchronizationStatus Object

    The status of incremental data migration.
    Status String Catched

    The status of incremental data migration. Valid values:

    • NotStarted: Not started.
    • Migrating: In progress.
    • Failed: Failed.
    • Finished: Complete.
    • Catched: No latency.
    Percent String 95

    The progress of incremental data migration. Unit: percentage.
    Delay String 0

    The latency of incremental data migration. Unit: seconds.
    ErrorMessage String The task failed and cannot be recovered.

    The error message returned if incremental data migration fails.
    Checkpoint String 1571040679

    The UNIX timestamp of the latest migrated incremental data. Unit: seconds.
    DestinationEndpoint Object

    The connection settings of the destination instance.
    DatabaseName String dtstestdata

    The name of the database to which the migration object in the destination instance belongs.
    InstanceId String rm-bpxxxxxxxx

    The ID of the destination instance.
    IP String 172.16.88.***

    The endpoint of the destination instance.
    InstanceType String RDS

    The type of the destination instance.
    Port String 3306

    The database service port of the destination instance.
    UserName String dtstest

    The database account of the destination instance.
    oracleSID String testsid

    The system ID (SID) of the Oracle database.

    Note This parameter is returned only if the database type of the destination instance is Oracle.
    EngineName String MySQL

    The database type of the destination instance.
    MigrationMode Object

    The migration types.
    dataInitialization Boolean true

    Indicates whether to perform initial full data synchronization. Valid values:

    • true: Yes.
    • false: No.
    dataSynchronization Boolean false.

    Indicates whether to perform incremental data migration. Valid values:

    • true: Yes.
    • false: No.
    structureInitialization Boolean false.

    Indicates whether to perform schema migration. Valid values:

    • true: Yes.
    • false: No.
    PrecheckStatus Object

    The precheck results.
    Status String Success

    The precheck status. Valid values:

    • NotStarted: Not started.
    • Checking: In progress.
    • Failed: Failed.
    • Finished: Complete.
    Percent String 100

    The overall precheck progress. Unit: percentage.
    Detail Array of CheckItem

    The check results of each precheck item.
    CheckItem
    CheckStatus String Success

    The check result. Valid values:

    • Success: The task passed the check.
    • Failed: The task failed the check.
    ErrorMessage String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

    The error message returned if the task fails the precheck.

    Note This parameter is returned only if the value of the CheckStatus parameter is Failed.
    ItemName String CHECK_CONN_SRC

    The precheck item.
    RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

    The method to fix the precheck failure.

    Note This parameter is returned only if the value of the CheckStatus parameter is Failed.
    SourceEndpoint Object

    The connection settings of the source instance.
    DatabaseName String dtstestdatabase

    The name of the database to which the migration object in the source instance belongs.
    InstanceId String rm-bp1i99e8l7913****

    The ID of the source instance.
    IP String 172.16.88.***

    The endpoint of the source instance.
    InstanceType String RDS

    The type of the source instance. Valid values:

    • RDS: ApsaraDB RDS instance.
    • ECS: Self-managed database that is hosted on an ECS instance.
    • LocalInstance: Self-managed database with a public IP address.
    • Express: Self-managed database that is connected over a leased line, VPN Gateway, or Smart Access Gateway.
    • MongoDB: ApsaraDB for MongoDB instance.
    • POLARDB: PolarDB for MySQL cluster. This value is available only on the Alibaba Cloud China Website (www.aliyun.com).
    Port String 3306

    The database service port of the source instance.
    UserName String dtstest

    The database account of the source instance.
    oracleSID String testsid

    The SID of the Oracle database.

    Note This parameter is returned only when the database type of the source database is Oracle.
    EngineName String MySQL

    The database type of the source instance.
    StructureInitializationStatus Object

    The status of schema migration.
    Status String Finished

    The status of schema migration. Valid values:

    • NotStarted: Not started.
    • Migrating: In progress.
    • Failed: Failed.
    • Finished: Complete.
    Percent String 100

    The progress of schema migration. Unit: percentage.
    ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

    The error message returned if schema migration fails.
    Progress String 1

    The number of tables whose schemas have been migrated.

    Examples

    Sample requests

    Sample success responses

    JSON format

    HTTP/1.1 200 OK

    Error codes

    HttpCode

    Error code

    Error message

    Description
    400 Throttling.User Request was denied due to user flow control. The request is denied due to user-level throttling. Try again later.
    403 InvalidSecurityToken.Expired Specified SecurityToken is expired. The specified security token has expired. Update the signature.
    500 ServiceUnavailable The request has failed due to a temporary failure of the server. The request failed because the server timed out or was unavailable. Retry the request. If the issue persists, contact technical support.

    For more error codes, see the Error Center.