Queries the list of Data Transmission Service (DTS) tasks and the details of each task.

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 DescribeDtsJobs

The operation that you want to perform. Set the value to DescribeDtsJobs.

Region String Yes cn-hangzhou

The ID of the region in which the DTS instance resides. For more information, see List of supported regions.

Type String No instance

The query condition for the required tasks. Valid values:

  • instance: queries by DTS instance ID.
  • name: queries by DTS instance name. Fuzzy match is supported.
  • srcRds: queries by an ApsaraDB RDS instance ID. The ApsaraDB RDS instance is the source instance of a DTS task.
  • rds: queries by an ApsaraDB RDS instance ID. The ApsaraDB RDS instance is the destination instance of a DTS task.
Note You must pass in the Params parameter to specify the content of the query condition.
Params String No dtspk3f13r731m****

The content of the query condition.

Note You must pass in Type to specify the content of the query condition.
Status String No Migrating

The state of the DTS task.

Valid values for a data migration task:

  • NotStarted: The task is not started.
  • Prechecking: The task is being prechecked.
  • PrecheckFailed: The task failed to pass the precheck.
  • PreCheckPass: The task passed the precheck.
  • NotConfigured: The task is not configured.
  • Migrating: The task is in progress.
  • Suspending: The task is paused.
  • MigrationFailed: The task failed to migrate data.
  • Finished: The task is completed.
  • Retrying: The task is being retried.
  • Upgrade: The task is being upgraded.
  • Locked: The task is locked.
  • Downgrade: The task is being downgraded.

Valid values for a data synchronization task:

  • NotStarted: The task is not started.
  • Prechecking: The task is being prechecked.
  • PrecheckFailed: The task failed to pass the precheck.
  • PreCheckPass: The task passed the precheck.
  • NotConfigured: The task is not configured.
  • Initializing: The task is being synchronized.
  • InitializeFailed: Initial synchronization failed.
  • Synchronizing: The task is in progress.
  • Failed: The task failed to synchronize data.
  • Suspending: The task is paused.
  • Modifying: The objects in the task are being modified.
  • Finished: The task is completed.
  • Retrying: The task is being retried.
  • Upgrade: The task is being upgraded.
  • Locked: The task is locked.
  • Downgrade: The task is being downgraded.

Valid values for a change tracking task:

  • NotConfigured: The task is not configured.
  • NotStarted: The task is not started.
  • Prechecking: The task is being prechecked.
  • PrecheckFailed: The task failed to pass the precheck.
  • PreCheckPass: The task passed the precheck.
  • Starting: The task is being started.
  • Normal: The task is running as expected.
  • Retrying: The task is being retried.
  • Abnormal: The task is not running as expected.
  • Upgrade: The task is being upgraded.
  • Locked: The task is locked.
  • Downgrade: The task is being downgraded.
OrderDirection String No ASC

Specifies the order to sort DTS tasks. Valid values:

  • ASC (default value): ascending order
  • DESC: descending order
OrderColumn String No CreateTime

Specifies the basis on which the returned DTS tasks are sorted. Valid values:

  • CreateTime: sorts DTS tasks based on the time when they are created
  • FinishTime: sorts DTS tasks based on the time when they are completed
Note You can also use the OrderDirection parameter to specify whether to sort DTS tasks in ascending order or descending order.
Tags String No [ { \"key\": \"testK\", \"value\": \"testV\" } ]

The tags that are used as query conditions. Specify tags in the JSON format.

Note You can call the ListTagResources operation to query the tag key and tag value.
PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

PageNumber Integer No 1

The number of the page to return. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.

JobType String No MIGRATION

The type of the DTS task. Valid values:

  • MIGRATION: (default value) data migration task
  • SYNC: data synchronization task
  • SUBSCRIBE: change tracking task
RegionId String No cn-hangzhou

The ID of the region in which the DTS instance resides. For more information, see List of supported regions.

GroupId String No pk13r731m****

The ID of the DTS task.

Note In most cases, you do not need to specify this parameter.

Response parameters

Parameter Type Example Description
DtsJobList Array of DtsJobStatus

The list of DTS tasks and the details of each task.

AppName String new

Indicates whether the new change tracking feature is used.

Note This parameter is returned only for change tracking instances of the new version.
BeginTimestamp String 2021-03-15T08:25:34Z

The start of the time range for change tracking. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

Checkpoint String 1616899019

The start offset of incremental data migration or data synchronization. The value is a UNIX timestamp. Unit: seconds.

ConsumptionCheckpoint String 2021-03-23T07:30:31Z

The consumption checkpoint of the change tracking instance. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

ConsumptionClient String 114...:dts******

The downstream client information, in the following format: <IP address of the downstream client>:<Random ID generated by DTS>.

CreateTime String 2021-03-16T08:01:19Z

The time when the task was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

DataEtlStatus Struct

The state of the extract, transform, and load (ETL) task. Valid values:

Note This parameter collection is returned only if an ETL task is configured.
ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if the task failed.

Percent String 95

The progress of the ETL task.

Progress String 0/0

The number of records that have been processed by the ETL task.

Status String Finished

The state of the ETL task. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
  • Catched: The task is not delayed.
DataInitializationStatus Struct

The state of full data migration or synchronization.

ErrorMessage String java.lang.NumberFormatException: For input string: ""

The error message returned if full data migration or synchronization failed.

Percent String 100

The progress of full data migration or synchronization. This is expressed as a percentage.

Progress String 44755

The number of records that have been migrated during full data migration or synchronization.

Status String Finished

The state of full data migration or synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: Full data migration or synchronization failed.
  • Finished: Full data migration or synchronization is completed.
DataSynchronizationStatus Struct

The state of incremental data migration or synchronization.

ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if incremental data migration or synchronization failed.

NeedUpgrade Boolean true

Indicates whether the instance needs to be upgraded. Valid values:

  • true: yes
  • false: no
Note To upgrade a DTS instance, call the TransferInstanceClass operation.
Percent String 95

The progress of incremental data migration or synchronization.

Progress String 0/0

The number of records that have been synchronized during incremental data migration or synchronization.

Status String Catched

The state of incremental data migration or synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: Incremental data migration or synchronization failed.
  • Finished: Incremental data migration or synchronization is completed.
  • Catched: The task is not delayed.
DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

The objects of the data migration, data synchronization, or change tracking task. For more information, see Objects of DTS tasks.

Delay Long 0

The latency of incremental data migration or synchronization.

Note If you query data migration tasks, the unit of this parameter is milliseconds. If you query data synchronization tasks, the unit of this parameter is seconds.
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.

InstanceID String rm-bp1imrtn6fq7h****

The ID of the destination instance.

InstanceType String RDS

The type of the destination instance.

Ip String 172.16.88.***

The endpoint of the destination instance.

OracleSID String testsid

The system ID (SID) of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the destination instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the destination instance.

Region String cn-hangzhou

The ID of the region where the destination instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the destination instance.

DtsInstanceID String dtsi03e3zty16i****

The ID of the data migration, data synchronization, or change tracking instance.

DtsJobClass String large

The instance class.

Note For more information about the test performance of each instance class, see Specifications of data migration instances and Specifications of data synchronization instances.
DtsJobDirection String Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse
Note This parameter is returned only if the topology of the data synchronization instance is two-way synchronization.
DtsJobId String i03e3zty16i****

The ID of the data migration, data synchronization, or change tracking task.

DtsJobName String RDS_TO_RDS_MIGRATION

The name of the data migration, data synchronization, or change tracking task.

EndTimestamp String 2021-03-26T14:03:21Z

The end of the time range for change tracking. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

ErrorMessage String DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].

The error message returned if the task failed.

ExpireTime String 2022-03-16T08:01:19Z

The time when the instance expires. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

Note This parameter is returned only if the return value of the PayType parameter is PrePaid.
MigrationMode Struct

The migration types or synchronization types.

DataInitialization Boolean true

Indicates whether full data migration or full data synchronization is performed. Valid values:

  • true: yes
  • false: no
DataSynchronization Boolean true

Indicates whether incremental data migration or synchronization is performed. Valid values:

  • true: yes
  • false: no
StructureInitialization Boolean true

Indicates whether schema migration or schema synchronization is performed. Valid values:

  • true: yes
  • false: no
OriginType String DTS

The source of the task.

  • PTS
  • DMS
  • DTS
PayType String PrePaid

The billing method of the DTS instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Performance Struct

The performance of the data migration or synchronization instance.

Flow String 1

The data traffic that is migrated or synchronized per second. Unit: MB/s.

Rps String 100

The number of times SQL statements are migrated or synchronized per second, including BEGIN, COMMIT, DML, and DDL statements. DML statements include INSERT, DELETE, and UPDATE.

PrecheckStatus Struct

The precheck state.

Detail Array of PrecheckDetail

The result of each precheck item.

CheckItem String CHECK_CONN_SRC

The name of the precheck item.

CheckItemDescription String CHECK_CONN_SRC_DETAIL

The description of the precheck item.

CheckResult String Success

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
FailedReason 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 CheckResult parameter is Failed.
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 CheckResult parameter is Failed.
ErrorMessage String CHECK__ERROR_SAME_OBJ.

The cause of the precheck failure.

Percent String 100

The precheck progress. This is expressed as a percentage.

Status String Finished

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

The reserved parameter of DTS. The value is a JSON string. You can specify this parameter to meet special requirements, for example, whether to automatically start a precheck. For more information, see MigrationReserved.

RetryState Struct

DTS is retrying the task due to an exception.

ErrMessage String Unexpected error

The error message returned if the retry failed.

MaxRetryTime Integer 7200

The maximum retry time. Unit: seconds.

RetryCount Integer 5

The number of retries.

RetryTarget String srcDB

The retry target. Valid values:

  • srcDB: the source database
  • destDB: the destination database
  • inner_module: an internal module of DTS
RetryTime Integer 3600

The retry time. Unit: seconds.

ReverseJob Struct

The details of the data synchronization task in the reverse direction.

Note This parameter is returned only for two-way data synchronization tasks.
Checkpoint String 1616980369

The start offset of incremental data synchronization. The value is a UNIX timestamp. Unit: seconds.

CreateTime String 2021-03-16T08:01:19Z

The time when the task was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

DataInitializationStatus Struct

The state of full data synchronization.

ErrorMessage String java.lang.NumberFormatException: For input string: ""

The error message returned if full data synchronization failed.

Percent String 100

The progress of full data synchronization. This is expressed as a percentage.

Progress String 43071

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

Status String Finished

The state of full data synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: Full data synchronization failed.
  • Finished: Full data synchronization is completed.
DataSynchronizationStatus Struct

The state of incremental data synchronization.

ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if incremental data synchronization failed.

NeedUpgrade Boolean true

Indicates whether the instance needs to be upgraded. Valid values:

  • true: yes
  • false: no
Note To upgrade a DTS instance, call the TransferInstanceClass operation.
Percent String 100

The progress of incremental data synchronization. This is expressed as a percentage.

Progress String 20001

The number of records that have been synchronized during incremental data migration or synchronization.

Status String Migrating

The state of incremental data synchronization.

DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

The objects that you want to synchronize. The value is a JSON string and can contain regular expressions. For more information, see "Objects of DTS tasks".

Delay Long 0

The latency of incremental data synchronization. Unit: seconds.

DestinationEndpoint Struct

The connection settings of the destination instance.

DatabaseName String dtstestdata

The name of the database to which the synchronization object in the destination instance belongs.

EngineName String MySQL

The database type of the destination instance.

InstanceID String rm-bp1162kryivb8****

The ID of the destination instance.

InstanceType String RDS

The type of the destination instance.

Ip String 172.16.88.***

The endpoint of the destination instance.

OracleSID String testsid

The system ID (SID) of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the destination instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the destination instance.

Region String cn-hangzhou

The ID of the region where the destination instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the destination instance.

DtsInstanceID String dtsi03e3zty16i****

The ID of the data synchronization instance.

DtsJobClass String large

The instance class.

Note For more information about the test performance of each instance class, see Specifications of data synchronization instances.
DtsJobDirection String Reverse

The synchronization direction. Valid value: Reverse.

DtsJobId String i03e3zty16i****

The ID of the data synchronization task.

DtsJobName String RDS_TO_RDS_MIGRATION

The name of the data synchronization task.

ErrorMessage String DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].

The error message returned if the task failed.

ExpireTime String 2022-03-16T08:01:19Z

The time when the instance expires. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

Note This parameter is returned only if the return value of the PayType parameter is PrePaid.
MigrationMode Struct

The synchronization types.

DataInitialization Boolean true

Indicates whether full data synchronization is performed. Valid values:

  • true: yes
  • false: no
DataSynchronization Boolean true

Indicates whether incremental data synchronization is performed. Valid values:

  • true: yes
  • false: no
StructureInitialization Boolean true

Indicates whether schema synchronization is performed. Valid values:

  • true: yes
  • false: no
PayType String PostPaid

The billing method of the DTS instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Performance Struct

The performance of the data synchronization instance.

Flow String 1

The data traffic that is synchronized per second. Unit: MB/s.

Rps String 100

The number of times SQL statements are synchronized per second, including BEGIN, COMMIT, DML, and DDL statements. DML statements include INSERT, DELETE, and UPDATE.

PrecheckStatus Struct

The precheck state.

Detail Array of PrecheckDetail

The result of each precheck item.

CheckItem String CHECK_CONN_SRC

The name of the precheck item.

CheckItemDescription String CHECK_CONN_SRC_DETAIL

The description of the precheck item.

CheckResult String Success

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
FailedReason 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.

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

The method to fix the precheck failure.

ErrorMessage String CHECK__ERROR_SAME_OBJ.

The cause of the precheck failure.

Percent String 100

The precheck progress. This is expressed as a percentage.

Status String Finished

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

The reserved parameter of DTS. The value is a JSON string. You can specify this parameter to meet special requirements, for example, whether to automatically start a precheck. For more information, see MigrationReserved.

SourceEndpoint Struct

The connection settings of the source instance.

DatabaseName String dtstestdata

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.

InstanceID String rm-bp1imrtn6fq7h****

The ID of the source instance.

InstanceType String RDS

The type of the source instance.

Ip String 172.16.88.***

The endpoint of the source instance.

OracleSID String testsid

The SID of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the source instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the source instance.

Region String cn-hangzhou

The ID of the region where the source instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the source instance.

Status String Synchronizing

The state of the DTS instance. For more information about the valid values, see the description of the request parameter Status.

StructureInitializationStatus Struct

The state of schema synchronization.

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

The error message returned if schema synchronization failed.

Percent String 100

The progress of schema synchronization. This is expressed as a percentage.

Progress String 1

The number of tables whose schemas have been synchronized.

Status String Finished

The state of schema synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
SourceEndpoint Struct

The connection settings of the source instance.

DatabaseName String dtstestdata

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.

InstanceID String rm-bp1162kryivb8****

The ID of the source instance.

InstanceType String RDS

The type of the source instance.

Ip String 172.16.88.***

The endpoint of the source instance.

OracleSID String testsid

The SID of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the source instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the source instance.

Region String cn-hangzhou

The ID of the region where the source instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the source instance.

Status String Migrating

The state of the DTS instance. For more information about the valid values, see the description of the request parameter Status.

StructureInitializationStatus Struct

The state of schema migration or schema synchronization.

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

The error message returned if schema migration or schema synchronization failed.

Percent String 100

The progress of schema migration or schema synchronization. This is expressed as a percentage.

Progress String 1

The number of tables whose schemas have been migrated or synchronized.

Status String Finished

The state of schema migration or schema synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
TagList Array of DtsTag

The collection of tags.

TagKey String testkey

The tag key.

TagValue String testvalue

The tag value.

DynamicCode String 403

The dynamic error code. This parameter will be removed in the future.

DynamicMessage String Type

The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter.

Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is Type, the specified Type parameter is invalid.
ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The Value of Input Parameter %s is not valid.

The error message returned if the call failed.

EtlDemoList Array of DtsJobStatus

The list of DTS tasks and the details of each task.

AppName String new

Indicates whether the new change tracking feature is used.

Note This parameter is returned only for change tracking instances of the new version.
BeginTimestamp String 2021-03-15T08:25:34Z

The start of the time range for change tracking. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

Checkpoint String 1616899019

The start offset of incremental data migration or data synchronization. The value is a UNIX timestamp. Unit: seconds.

ConsumptionCheckpoint String 2021-03-23T07:30:31Z

The consumption checkpoint of the change tracking instance. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

ConsumptionClient String 114...:dts******

The downstream client information, in the following format: <IP address of the downstream client>:<Random ID generated by DTS>.

CreateTime String 2021-03-16T08:01:19Z

The time when the task was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

DataEtlStatus Struct

The state of the extract, transform, and load (ETL) task. Valid values:

Note This parameter collection is returned only if an ETL task is configured.
ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if the task failed.

Percent String 95

The progress of the ETL task.

Progress String 0/0

The number of records that have been processed by the ETL task.

Status String Finished

The state of the ETL task. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
  • Catched: The task is not delayed.
DataInitializationStatus Struct

The state of full data migration or synchronization.

ErrorMessage String java.lang.NumberFormatException: For input string: ""

The error message returned if full data migration or synchronization failed.

Percent String 100

The progress of full data migration or synchronization. This is expressed as a percentage.

Progress String 44755

The number of records that have been migrated during full data migration or synchronization.

Status String Finished

The state of full data migration or synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
DataSynchronizationStatus Struct

The state of incremental data migration or synchronization.

ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if incremental data migration or synchronization failed.

NeedUpgrade Boolean true

Indicates whether the instance needs to be upgraded. Valid values:

  • true: yes
  • false: no
Note To upgrade a DTS instance, call the TransferInstanceClass operation.
Percent String 95

The progress of incremental data migration or synchronization.

Progress String 0/0

The number of records that have been synchronized during incremental data migration or synchronization.

Status String Catched

The state of incremental data migration or synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
  • Catched: The task is not delayed.
DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

The objects of the data migration, data synchronization, or change tracking task. For more information, see Objects of DTS tasks.

Delay Long 0

The latency of incremental data migration or synchronization.

Note If you query data migration tasks, the unit of this parameter is milliseconds. If you query data synchronization tasks, the unit of this parameter is seconds.
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.

InstanceID String rm-bp1imrtn6fq7h****

The ID of the destination instance.

InstanceType String RDS

The type of the destination instance.

Ip String 172.16.88.***

The endpoint of the destination instance.

OracleSID String testsid

The system ID (SID) of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the destination instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the destination instance.

Region String cn-hangzhou

The ID of the region where the destination instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the destination instance.

DtsInstanceID String dtsi03e3zty16i****

The ID of the data migration, data synchronization, or change tracking instance.

DtsJobClass String large

The instance class.

Note For more information about the test performance of each instance class, see Specifications of data migration instances and Specifications of data synchronization instances.
DtsJobDirection String Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse
Note This parameter is returned only if the topology of the data synchronization instance is two-way synchronization.
DtsJobId String i03e3zty16i****

The ID of the data migration, data synchronization, or change tracking task.

DtsJobName String RDS_TO_RDS_MIGRATION

The name of the data migration, data synchronization, or change tracking task.

EndTimestamp String 2021-03-26T14:03:21Z

The end of the time range for change tracking. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

ErrorMessage String DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].

The error message returned if the task failed.

ExpireTime String 2022-03-16T08:01:19Z

The time when the instance expires. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

Note This parameter is returned only if the return value of the PayType parameter is PrePaid.
MigrationMode Struct

The migration types or synchronization types.

DataInitialization Boolean true

Indicates whether full data migration or full data synchronization is performed. Valid values:

  • true: yes
  • false: no
DataSynchronization Boolean true

Indicates whether incremental data migration or synchronization is performed. Valid values:

  • true: yes
  • false: no
StructureInitialization Boolean true

Indicates whether schema migration or schema synchronization is performed. Valid values:

  • true: yes
  • false: no
OriginType String DTS

The source of the task.

  • PTS
  • DMS
  • DTS
PayType String PrePaid

The billing method of the DTS instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Performance Struct

The performance of the data migration or synchronization instance.

Flow String 1

The data traffic that is migrated or synchronized per second. Unit: MB/s.

Rps String 100

The number of times SQL statements are migrated or synchronized per second, including BEGIN, COMMIT, DML, and DDL statements. DML statements include INSERT, DELETE, and UPDATE.

PrecheckStatus Struct

The precheck state.

Detail Array of PrecheckDetail

The result of each precheck item.

CheckItem String CHECK_CONN_SRC

The name of the precheck item.

CheckItemDescription String CHECK_CONN_SRC_DETAIL

The description of the precheck item.

CheckResult String Success

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
FailedReason 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 CheckResult parameter is Failed.
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 CheckResult parameter is Failed.
ErrorMessage String CHECK__ERROR_SAME_OBJ.

The cause of the precheck failure.

Percent String 100

The precheck progress. This is expressed as a percentage.

Status String Finished

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

The reserved parameter of DTS. The value is a JSON string. You can specify this parameter to meet special requirements, for example, whether to automatically start a precheck. For more information, see MigrationReserved.

RetryState Struct

DTS is retrying the task due to an exception.

ErrMessage String Unexpected error

The error message returned if the retry failed.

MaxRetryTime Integer 7200

The maximum retry time. Unit: seconds.

RetryCount Integer 5

The number of retries.

RetryTarget String srcDB

The retry target. Valid values:

  • srcDB: the source database
  • destDB: the destination database
  • inner_module: an internal module of DTS
RetryTime Integer 3600

The retry time. Unit: seconds.

ReverseJob Struct

The details of the data synchronization task in the reverse direction.

Note This parameter is returned only for two-way data synchronization tasks.
Checkpoint String 1616980369

The start offset of incremental data synchronization. The value is a UNIX timestamp. Unit: seconds.

CreateTime String 2021-03-16T08:01:19Z

The time when the task was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

DataInitializationStatus Struct

The state of full data synchronization.

ErrorMessage String java.lang.NumberFormatException: For input string: ""

The error message returned if full data synchronization failed.

Percent String 100

The progress of full data synchronization. This is expressed as a percentage.

Progress String 43071

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

Status String Finished

The state of full data synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
DataSynchronizationStatus Struct

The state of incremental data synchronization.

ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if incremental data synchronization failed.

NeedUpgrade Boolean true

Indicates whether the instance needs to be upgraded. Valid values:

  • true: yes
  • false: no
Note To upgrade a DTS instance, call the TransferInstanceClass operation.
Percent String 100

The progress of incremental data synchronization. This is expressed as a percentage.

Progress String 20001

The number of records that have been synchronized during incremental data migration or synchronization.

Status String Migrating

The state of incremental data synchronization.

DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

The objects that you want to synchronize. The value is a JSON string and can contain regular expressions. For more information, see "Objects of DTS tasks".

Delay Long 0

The latency of incremental data synchronization. Unit: seconds.

DestinationEndpoint Struct

The connection settings of the destination instance.

DatabaseName String dtstestdata

The name of the database to which the synchronization object in the destination instance belongs.

EngineName String MySQL

The database type of the destination instance.

InstanceID String rm-bp1162kryivb8****

The ID of the destination instance.

InstanceType String RDS

The type of the destination instance.

Ip String 172.16.88.***

The endpoint of the destination instance.

OracleSID String testsid

The system ID (SID) of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the destination instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the destination instance.

Region String cn-hangzhou

The ID of the region where the destination instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the destination instance.

DtsInstanceID String dtsi03e3zty16i****

The ID of the data synchronization instance.

DtsJobClass String large

The instance class.

Note For more information about the test performance of each instance class, see Specifications of data synchronization instances.
DtsJobDirection String Reverse

The synchronization direction. Valid value: Reverse.

DtsJobId String i03e3zty16i****

The ID of the data synchronization task.

DtsJobName String RDS_TO_RDS_MIGRATION

The name of the data synchronization task.

ErrorMessage String DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].

The error message returned if the task failed.

ExpireTime String 2022-03-16T08:01:19Z

The time when the instance expires. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

Note This parameter is returned only if the return value of the PayType parameter is PrePaid.
MigrationMode Struct

The migration types or synchronization types.

DataInitialization Boolean true

Indicates whether full data migration or full data synchronization is performed. Valid values:

  • true: yes
  • false: no
DataSynchronization Boolean true

Indicates whether incremental data migration or synchronization is performed. Valid values:

  • true: yes
  • false: no
StructureInitialization Boolean true

Indicates whether schema migration or schema synchronization is performed. Valid values:

  • true: yes
  • false: no
PayType String PostPaid

The billing method of the DTS instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Performance Struct

The performance of the data migration or synchronization instance.

Flow String 1

The data traffic that is migrated or synchronized per second. Unit: MB/s.

Rps String 100

The number of times SQL statements are migrated or synchronized per second, including BEGIN, COMMIT, DML, and DDL statements. DML statements include INSERT, DELETE, and UPDATE.

PrecheckStatus Struct

The precheck state.

Detail Array of PrecheckDetail

The result of each precheck item.

CheckItem String CHECK_CONN_SRC

The name of the precheck item.

CheckItemDescription String CHECK_CONN_SRC_DETAIL

The description of the precheck item.

CheckResult String Success

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
FailedReason 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 CheckResult parameter is Failed.
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 CheckResult parameter is Failed.
ErrorMessage String CHECK__ERROR_SAME_OBJ

The cause of the precheck failure.

Percent String 100

The precheck progress. This is expressed as a percentage.

Status String Finished

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

The reserved parameter of DTS. The value is a JSON string. You can specify this parameter to meet special requirements, for example, whether to automatically start a precheck. For more information, see MigrationReserved.

SourceEndpoint Struct

The connection settings of the source instance.

DatabaseName String dtstestdata

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.

InstanceID String rm-bp1imrtn6fq7h****

The ID of the source instance.

InstanceType String RDS

The type of the source instance.

Ip String 172.16.88.***

The endpoint of the source instance.

OracleSID String testsid

The SID of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the source instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the source instance.

Region String cn-hangzhou

The ID of the region where the source instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the source instance.

Status String Synchronizing

The state of the DTS instance. For more information about the valid values, see the description of the request parameter Status.

StructureInitializationStatus Struct

The state of schema synchronization.

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

The error message returned if schema synchronization failed.

Percent String 100

The progress of schema synchronization. This is expressed as a percentage.

Progress String 1

The number of tables whose schemas have been synchronized.

Status String Finished

The state of schema synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
SourceEndpoint Struct

The connection settings of the source instance.

DatabaseName String dtstestdata

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.

InstanceID String rm-bp1162kryivb8****

The ID of the source instance.

InstanceType String RDS

The type of the source instance.

Ip String 172.16.88.***

The endpoint of the source instance.

OracleSID String testsid

The SID of the Oracle database.

Note This parameter is returned only if the EngineName parameter of the source instance is set to Oracle and the Oracle database is deployed in a non-RAC architecture.
Port String 3306

The database service port of the source instance.

Region String cn-hangzhou

The ID of the region where the source instance resides. For more information, see List of supported regions.

SslSolutionEnum String DISABLE

Indicates whether SSL encryption is enabled. Valid values:

  • DISABLE: SSL encryption is disabled.
  • ENABLE_WITH_CERTIFICATE: SSL encryption is enabled and the CA certificate is uploaded.
  • ENABLE_ONLY_4_MONGODB_ALTAS: SSL encryption is enabled for the connection to an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection to a Kafka cluster.
UserName String dtstest

The database account of the source instance.

Status String Migrating

The state of the DTS instance. For more information about the valid values, see the description of the request parameter Status.

StructureInitializationStatus Struct

The state of schema migration or schema synchronization.

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

The error message returned if schema migration or schema synchronization failed.

Percent String 100

The progress of schema migration or schema synchronization. This is expressed as a percentage.

Progress String 1

The number of tables whose schemas have been migrated or synchronized.

Status String Finished

The state of schema migration or schema synchronization. Valid values:

  • NotStarted: The task is not started.
  • Migrating: The task is in progress.
  • Failed: The task failed.
  • Finished: The task is completed.
TagList Array of DtsTag

The collection of tags.

TagKey String testkey

The tag key.

TagValue String testvalue

The tag value.

HttpStatusCode Integer 200

The HTTP status code.

JobType String MIGRATION

The type of the DTS task. Valid values:

  • MIGRATION: data migration instance
  • SYNC: data synchronization instance
  • SUBSCRIBE: change tracking instance
PageNumber Integer 2

The number of the page to return.

PageRecordCount Integer 20

The maximum number of entries that can be displayed on the current page.

RequestId String 621BB4F8-3016-4FAA-8D5A-5D3163CC****

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

TotalRecordCount Integer 15

The total number of DTS tasks that meet the query conditions.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeDtsJobs
&Region=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

<DescribeDtsJobsResponse>
      <TotalRecordCount>15</TotalRecordCount>
      <PageRecordCount>1</PageRecordCount>
      <DtsJobList>
            <Status>Migrating</Status>
            <DataInitializationStatus>
                  <Status>Finished</Status>
                  <Progress>44755</Progress>
                  <Percent>100</Percent>
            </DataInitializationStatus>
            <DbObject>{"DTSTEST":{"name":"dtstest","all":true,"state":"normal","edit":false}}</DbObject>
            <CreateTime>2021-03-16T08:01:19Z</CreateTime>
            <DtsJobName>RDS_TO_RDS_MIGRATION</DtsJobName>
            <ReverseJob>
                  <PrecheckStatus></PrecheckStatus>
                  <DataInitializationStatus></DataInitializationStatus>
                  <DestinationEndpoint></DestinationEndpoint>
                  <SourceEndpoint></SourceEndpoint>
                  <Performance></Performance>
                  <MigrationMode></MigrationMode>
                  <StructureInitializationStatus></StructureInitializationStatus>
                  <DataSynchronizationStatus></DataSynchronizationStatus>
            </ReverseJob>
            <PayType>PrePaid</PayType>
            <DtsInstanceID>dtsi03e3zty16i****</DtsInstanceID>
            <Delay>0</Delay>
            <MigrationMode>
                  <DataInitialization>true</DataInitialization>
                  <DataSynchronization>true</DataSynchronization>
                  <StructureInitialization>true</StructureInitialization>
            </MigrationMode>
            <PrecheckStatus>
                  <Status>Finished</Status>
                  <Percent>100</Percent>
                  <Detail>
                        <CheckItem>CHECK_CONN_SRC</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_CONN_SRC_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_CONN_DEST</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_CONN_DEST_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_AUTH_SRC</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_AUTH_SRC_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_AUTH_DEST</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_AUTH_DEST_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_BINLOG_ON</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_BINLOG_ON_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_BINLOG_MODE</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_BINLOG_MODE_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_BINLOG_ROW_IMAGE</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_BINLOG_ROW_IMAGE_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_SERVER_ID</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_SERVER_ID_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_BINLOG_EXIST</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_BINLOG_EXIST_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_ENGINE</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_ENGINE_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_MYSQL_PASSOWRD_FORMAT</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_MYSQL_PASSOWRD_FORMAT_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_SRC</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_SRC_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_SAME_OBJ</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_SAME_OBJ_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_SQL_MODE</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_SQL_MODE_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_SAME_USER</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_SAME_USER_DETAIL</CheckItemDescription>
                  </Detail>
                  <Detail>
                        <CheckItem>CHECK_TOPOLOGY</CheckItem>
                        <CheckResult>Success</CheckResult>
                        <CheckItemDescription>CHECK_TOPOLOGY_DETAIL</CheckItemDescription>
                  </Detail>
            </PrecheckStatus>
            <DtsJobClass>large</DtsJobClass>
            <Checkpoint>1616902385</Checkpoint>
            <DtsJobId>i03e3zty16i****</DtsJobId>
            <DestinationEndpoint>
                  <UserName>dtstest</UserName>
                  <InstanceID>rm-bp1imrtn6fq7h****</InstanceID>
                  <SslSolutionEnum>DISABLE</SslSolutionEnum>
                  <Port>3306</Port>
                  <DatabaseName></DatabaseName>
                  <Region>cn-hangzhou</Region>
                  <InstanceType>RDS</InstanceType>
                  <EngineName>MySQL</EngineName>
            </DestinationEndpoint>
            <SourceEndpoint>
                  <UserName>dtstest</UserName>
                  <InstanceID>rm-bp1162kryivb8****</InstanceID>
                  <SslSolutionEnum>DISABLE</SslSolutionEnum>
                  <Port>3306</Port>
                  <Region>cn-hangzhou</Region>
                  <InstanceType>RDS</InstanceType>
                  <EngineName>MySQL</EngineName>
            </SourceEndpoint>
            <TagList>
                  <TagKey>testkey</TagKey>
                  <TagValue>testvalue</TagValue>
            </TagList>
            <Performance></Performance>
            <Reserved>{"srcHostPorts":"","whitelist.dms.online.ddl.enable":false,"filterDDL":false,"sqlparser.dms.original.ddl":true,"srcOracleType":"sid","maxRetryTime":43200,"destSSL":"0","destOracleType":"sid","srcSSL":"0","dbListCaseChangeMode":"default","SourceEngineVersion":"8.0.18","srcNetType":"VPC","destNetType":"VPC","srcVpcNetMappingInst":"172.16.1**.**:10803","destVpcNetMappingInst":"172.16.1**.**:11077","useJobTask":"1"}</Reserved>
            <StructureInitializationStatus>
                  <Status>Finished</Status>
                  <Progress>1</Progress>
                  <Percent>100</Percent>
            </StructureInitializationStatus>
            <DataSynchronizationStatus>
                  <Status>Catched</Status>
                  <Progress>0/0</Progress>
                  <Percent>95</Percent>
            </DataSynchronizationStatus>
      </DtsJobList>
      <RequestId>621BB4F8-3016-4FAA-8D5A-5D3163CC****</RequestId>
      <PageNumber>2</PageNumber>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</DescribeDtsJobsResponse>

JSON format 

{
	"TotalRecordCount": 15,
	"PageRecordCount": 1,
	"DtsJobList": [
		{
			"Status": "Migrating",
			"DataInitializationStatus": {
				"Status": "Finished",
				"Progress": "44755",
				"Percent": "100"
			},
			"DbObject": "{\"DTSTEST\":{\"name\":\"dtstest\",\"all\":true,\"state\":\"normal\",\"edit\":false}}",
			"CreateTime": "2021-03-16T08:01:19Z",
			"DtsJobName": "RDS_TO_RDS_MIGRATION",
			"ReverseJob": {
				"PrecheckStatus": {},
				"DataInitializationStatus": {},
				"DestinationEndpoint": {},
				"SourceEndpoint": {},
				"Performance": {},
				"MigrationMode": {},
				"StructureInitializationStatus": {},
				"DataSynchronizationStatus": {}
			},
			"PayType": "PrePaid",
			"DtsInstanceID": "dtsi03e3zty16i****",
			"Delay": 0,
			"MigrationMode": {
				"DataInitialization": true,
				"DataSynchronization": true,
				"StructureInitialization": true
			},
			"PrecheckStatus": {
				"Status": "Finished",
				"Percent": "100",
				"Detail": [
					{
						"CheckItem": "CHECK_CONN_SRC",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_CONN_SRC_DETAIL"
					},
					{
						"CheckItem": "CHECK_CONN_DEST",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_CONN_DEST_DETAIL"
					},
					{
						"CheckItem": "CHECK_AUTH_SRC",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_AUTH_SRC_DETAIL"
					},
					{
						"CheckItem": "CHECK_AUTH_DEST",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_AUTH_DEST_DETAIL"
					},
					{
						"CheckItem": "CHECK_BINLOG_ON",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_BINLOG_ON_DETAIL"
					},
					{
						"CheckItem": "CHECK_BINLOG_MODE",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_BINLOG_MODE_DETAIL"
					},
					{
						"CheckItem": "CHECK_BINLOG_ROW_IMAGE",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_BINLOG_ROW_IMAGE_DETAIL"
					},
					{
						"CheckItem": "CHECK_SERVER_ID",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_SERVER_ID_DETAIL"
					},
					{
						"CheckItem": "CHECK_BINLOG_EXIST",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_BINLOG_EXIST_DETAIL"
					},
					{
						"CheckItem": "CHECK_ENGINE",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_ENGINE_DETAIL"
					},
					{
						"CheckItem": "CHECK_MYSQL_PASSOWRD_FORMAT",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_MYSQL_PASSOWRD_FORMAT_DETAIL"
					},
					{
						"CheckItem": "CHECK_SRC",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_SRC_DETAIL"
					},
					{
						"CheckItem": "CHECK_SAME_OBJ",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_SAME_OBJ_DETAIL"
					},
					{
						"CheckItem": "CHECK_SQL_MODE",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_SQL_MODE_DETAIL"
					},
					{
						"CheckItem": "CHECK_SAME_USER",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_SAME_USER_DETAIL"
					},
					{
						"CheckItem": "CHECK_TOPOLOGY",
						"CheckResult": "Success",
						"CheckItemDescription": "CHECK_TOPOLOGY_DETAIL"
					}
				]
			},
			"DtsJobClass": "large",
			"Checkpoint": "1616902385",
			"DtsJobId": "i03e3zty16i****",
			"DestinationEndpoint": {
				"UserName": "dtstest",
				"InstanceID": "rm-bp1imrtn6fq7h****",
				"SslSolutionEnum": "DISABLE",
				"Port": "3306",
				"DatabaseName": "",
				"Region": "cn-hangzhou",
				"InstanceType": "RDS",
				"EngineName": "MySQL"
			},
			"SourceEndpoint": {
				"UserName": "dtstest",
				"InstanceID": "rm-bp1162kryivb8****",
				"SslSolutionEnum": "DISABLE",
				"Port": "3306",
				"Region": "cn-hangzhou",
				"InstanceType": "RDS",
				"EngineName": "MySQL"
			},
			"TagList": [
				{
					"TagKey": "testkey",
					"TagValue": "testvalue"
				}
			],
			"Performance": {},
			"Reserved": 
"{\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}",
			"StructureInitializationStatus": {
				"Status": "Finished",
				"Progress": "1",
				"Percent": "100"
			},
			"DataSynchronizationStatus": {
				"Status": "Catched",
				"Progress": "0/0",
				"Percent": "95"
			}
		}
	],
	"RequestId": "621BB4F8-3016-4FAA-8D5A-5D3163CC****",
	"PageNumber": 2,
	"HttpStatusCode": 200,
	"Success": true
}

Error codes

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