DescribeMigrationJobStatus - Data Transmission Service - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeMigrationJobStatus	The operation that you want to perform. Set the value to DescribeMigrationJobStatus.
MigrationJobId	String	Yes	dtsz2v12jfo309****	The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the instance ID.
RegionId	String	No	cn-hangzhou	The ID of the region where the data migration instance resides. For more information, see List of supported regions.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The ClientToken value 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 because this parameter will be removed in the future.

Response parameters


Parameter	Type	Example	Description
DataInitializationStatus	Struct		The status of full data migration.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if full data migration failed.
Percent	String	100	The migration progress. Unit: %.
Progress	String	200001	The number of records that have been migrated during full data migration.
Status	String	Finished	The status of full data migration. Valid values: NotStarted: Full data migration is not started. Migrating: Full data migration is in progress. Failed: Full data migration failed. Finished: Full data migration is completed.
DataSynchronizationStatus	Struct		The status of incremental data migration.
Checkpoint	String	1612507847	The UNIX timestamp generated when the latest incremental data is migrated. Unit: seconds.
Delay	String	0	The latency of incremental data migration. Unit: seconds.
ErrorMessage	String	The task has failed for a long time and cannot be recovered.	The error message returned if incremental data migration failed.
Percent	String	95	The progress of incremental data migration. Unit: %.
Status	String	Catched	The status of incremental data migration. Valid values: NotStarted: Incremental data migration is not started. Migrating: Incremental data migration is in progress. Failed: Incremental data migration failed. Finished: Incremental data migration is completed. Catched: Incremental data migration is not delayed.
DestinationEndpoint	Struct		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.
EngineName	String	MySQL	The database type of the destination instance.
IP	String	172.16.88.***	The endpoint of the destination instance.
InstanceId	String	rm-bp1zc3iyqe3qw****	The ID 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.
ErrCode	String	InternalError	The error code returned if the call failed.
ErrMessage	String	The request processing has failed due to some unknown error.	The error message returned if the call failed.
MigrationJobClass	String	2xlarge	The specification of the data migration instance. Valid values: small, medium, large, xlarge, and 2xlarge. For more information, see Specifications of data migration instances.
MigrationJobId	String	dtsz2v12jfo309****	The ID of the data migration instance.
MigrationJobName	String	MySQL Migration	The name of the data migration task.
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 to pass the precheck. Migrating: The task is migrating data. Suspending: The task is paused. MigrationFailed: The task failed to migrate data. Finished: The task is completed.
MigrationMode	Struct		The migration types.
dataInitialization	Boolean	true	Indicates whether full data migration is performed. Valid values: true: yes false: no
dataSynchronization	Boolean	true	Indicates whether incremental data migration is performed. Valid values: true: yes false: no
structureInitialization	Boolean	true	Indicates whether schema migration is performed. Valid values: true: yes false: no
MigrationObject	String	[{\"DBName\":\"dtstestdata\",\"TableIncludes\":[{\"TableName\":\"customer\"}]}]	The objects that are migrated by the task.
PayType	String	PostPaid	The billing method of the data migration instance. The value is PostPaid (pay-as-you-go).
PrecheckStatus	Struct		The precheck details.
Detail	Array of CheckItem		The result of each precheck item.
CheckItem
CheckStatus	String	Success	The precheck result. Valid values: Success: The task passed the precheck. Failed: The task failed to pass the precheck.
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	The error message returned if the task failed to pass the precheck. Note This parameter is returned only if the return value of the CheckStatus parameter is Failed.
ItemName	String	CHECK_CONN_SRC	The name of 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 return value of the CheckStatus parameter is Failed.
Percent	String	100	The precheck progress. Unit: %.
Status	String	Finished	The precheck status. Valid values: NotStarted Suspending: Checking Failed Finished
RequestId	String	A032E3B4-929B-48E9-97B9-37587CBF****	The ID of the request.
SourceEndpoint	Struct		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.
EngineName	String	MySQL	The database type of the source instance.
IP	String	172.16.88.***	The endpoint of the source instance.
InstanceId	String	rm-bp1i99e8l7913****	The ID of the source instance.
InstanceType	String	RDS	The type of the source instance. RDS: ApsaraDB RDS instance ECS: self-managed database that is hosted on Elastic Compute Service (ECS) LocalInstance: self-managed database with a public IP address Express: self-managed database that is connected over Express Connect, VPN Gateway, or Smart Access Gateway MongoDB: ApsaraDB for MongoDB instance POLARDB: PolarDB for MySQL cluster (available only for the China site)
Port	String	3306	The database service port of the source instance.
UserName	String	dtstest	The database account of the source instance.
oracleSID	String	dtstestdatabase	The SID of the Oracle database. Note This parameter is returned only if the database type of the source instance is Oracle.
StructureInitializationStatus	Struct		The status of schema migration.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	The error message returned if schema migration failed.
Percent	String	100	The progress of schema migration. Unit: %.
Progress	String	1	The number of tables whose schemas have been migrated.
Status	String	Finished	The status of schema migration. Valid values: NotStarted: Schema migration is not started. Migrating: Schema migration is in progress. Failed: Schema migration failed. Finished: Schema migration is completed.
Success	String	true	Indicates whether the call was successful.
TaskId	String	z2v12jfo309****	The ID of the data migration task. You can use the task ID to configure the link to the task details page in the DTS console. Note The link to the task details page is https://dts.console.aliyun.com/#/progress/z2v12jfo309/config/.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeMigrationJobStatus
&MigrationJobId=dtsta7w132u12h****
&<Common request parameters>

Sample success responses

XML format

<DescribeMigrationJobStatusResponse>
      <TaskId>z2v12jfo309****</TaskId>
      <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>200001</Progress>
            <Percent>100</Percent>
      </DataInitializationStatus>
      <RequestId>A032E3B4-929B-48E9-97B9-37587CBF****</RequestId>
      <MigrationJobName>MySQL Migration</MigrationJobName>
      <PayType>PostPaid</PayType>
      <MigrationJobStatus>Migrating</MigrationJobStatus>
      <Success>true</Success>
      <MigrationMode>
            <structureInitialization>true</structureInitialization>
            <dataSynchronization>true</dataSynchronization>
            <dataInitialization>true</dataInitialization>
      </MigrationMode>
      <MigrationJobId>dtsz2v12jfo309****</MigrationJobId>
      <PrecheckStatus>
            <Status>Finished</Status>
            <Percent>100</Percent>
            <Detail>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_CONN_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_AUTH_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_CONN_DEST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_AUTH_DEST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_ON</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_MODE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_ROW_IMAGE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SERVER_ID</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_EXIST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_ENGINE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_MYSQL_PASSOWRD_FORMAT</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SQL_MODE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SAME_USER</ItemName>
                  </CheckItem>
            </Detail>
      </PrecheckStatus>
      <DestinationEndpoint>
            <UserName>dtstest</UserName>
            <InstanceId>rm-bp1zc3iyqe3qw****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </DestinationEndpoint>
      <MigrationJobClass>2xlarge</MigrationJobClass>
      <SourceEndpoint>
            <UserName>dtstest</UserName>
            <InstanceId>rm-bp1i99e8l7913****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </SourceEndpoint>
      <DataSynchronizationStatus>
            <Status>Catched</Status>
            <Checkpoint>1612507847</Checkpoint>
            <Percent>95</Percent>
            <Delay>0</Delay>
      </DataSynchronizationStatus>
      <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
      </StructureInitializationStatus>
</DescribeMigrationJobStatusResponse>

JSON format

{
    "TaskId": "z2v12jfo309****",
    "DataInitializationStatus": {
        "Status": "Finished",
        "Progress": "200001",
        "Percent": "100"
    },
    "RequestId": "A032E3B4-929B-48E9-97B9-37587CBF****",
    "MigrationJobName": "MySQL Migration",
    "PayType": "PostPaid",
    "MigrationJobStatus": "Migrating",
    "Success": true,
    "MigrationMode": {
        "structureInitialization": true,
        "dataSynchronization": true,
        "dataInitialization": true
    },
    "MigrationJobId": "dtsz2v12jfo309****",
    "PrecheckStatus": {
        "Status": "Finished",
        "Percent": "100",
        "Detail": {
            "CheckItem": [
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_CONN_SRC"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_AUTH_SRC"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_CONN_DEST"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_AUTH_DEST"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_BINLOG_ON"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_BINLOG_MODE"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_BINLOG_ROW_IMAGE"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_SERVER_ID"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_BINLOG_EXIST"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_ENGINE"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_MYSQL_PASSOWRD_FORMAT"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_SRC"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_SQL_MODE"
                },
                {
                    "CheckStatus": "Success",
                    "ItemName": "CHECK_SAME_USER"
                }
            ]
        }
    },
    "DestinationEndpoint": {
        "UserName": "dtstest",
        "InstanceId": "rm-bp1zc3iyqe3qw****",
        "InstanceType": "RDS",
        "EngineName": "MySQL"
    },
    "MigrationJobClass": "2xlarge",
    "SourceEndpoint": {
        "UserName": "dtstest",
        "InstanceId": "rm-bp1i99e8l7913****",
        "InstanceType": "RDS",
        "EngineName": "MySQL"
    },
    "DataSynchronizationStatus": {
        "Status": "Catched",
        "Checkpoint": "1612507847",
        "Percent": "95",
        "Delay": "0"
    },
    "StructureInitializationStatus": {
        "Status": "Finished",
        "Progress": "1",
        "Percent": "100"
    }
}

Error codes

For a list of error codes, visit the API Error Center.