Query the list of DTS tasks and the execution details of each task - Data Transmission Service

You can call the DescribeDtsJobs operation to query DTS tasks and their execution details.

This operation is rate-limited. Calls that exceed the limit are rejected.

The number of calls to this operation is limited to 200 per second for each region.
The number of calls to this operation is limited to 20 per second for each Alibaba Cloud account in a region.

Test

You can call this operation in OpenAPI Explorer to simplify the signature calculation process. After a successful call, OpenAPI Explorer automatically generates SDK code examples.

Request parameters

Name	Type	Required	Example	Description
Action	String	Yes	DescribeDtsJobs	A required parameter. Set the value to DescribeDtsJobs.
Type	String	No	instance	The query condition. Valid values: instance: Query by DTS instance ID. name: Query by DTS instance name. Fuzzy search is supported. srcRds: Query by source ApsaraDB RDS instance ID. rds: Query by destination ApsaraDB RDS instance ID. Note You must specify the Params parameter to define the query condition.
Params	String	No	dtspk3f13r731m****	The details of the query condition. Note You must specify the Type parameter to define the query condition.
Region	String	Yes	cn-hangzhou	The region where the DTS instance resides. For more information, see Supported regions.
Status	String	No	Migrating	The status of the DTS instance. Valid values: Data migration task statuses: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Migrating: The task is in progress. Suspending: The task is paused. MigrationFailed: The task failed. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded. Data synchronization task statuses: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Initializing: The task is initializing. InitializeFailed: The initialization failed. Synchronizing: The task is in progress. Failed: The task failed. Suspending: The task is paused. Modifying: The synchronization objects are being modified. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded. Data tracking task statuses: NotConfigured: The task is not configured. NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. Starting: The task is starting. Normal: The task is running as normal. Retrying: The task is being retried. Abnormal: The task is not running as expected. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded.
OrderDirection	String	No	ASC	The order in which to sort the DTS instances. Valid values: ASC: Ascending order. This is the default value. DESC: Descending order.
OrderColumn	String	No	CreateTime	If the response contains multiple DTS instances, specify the sorting basis. Valid values: CreateTime: Sort by the creation time of the task. FinishTime: Sort by the completion time of the task. duLimit (for dedicated cluster tasks): Sort by the upper limit of DUs used by the DTS task. This is only supported for dedicated clusters. Note You can also specify the OrderDirection parameter to set the sorting order to ascending or descending.
Tags	String	No	[ { "key": "testK", "value": "testV" } ]	The tags used for filtering, in JSON format. Note You can query the keys and values of tags by calling the ListTagResources operation.
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 10, 20, and 30. Default value: 20. Maximum value: 30.
PageNumber	Integer	No	1	The page number. 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: Data migration (default). SYNC: Data synchronization. SUBSCRIBE: Data tracking.
RegionId	String	No	N/A	This parameter is deprecated.
GroupId	String	No	pk13r731m****	The ID of the DTS task. Note You do not need to set this parameter in most cases.
DedicatedClusterId	String	No	dtscluster_atyl3b5214uk***	The ID of the DTS dedicated cluster.
DtsJobId	String	No	qa110wq5r93hb49	The ID of the data migration, synchronization, or tracking task. Note Separate multiple task IDs with commas (,). Make sure that the value of the JobType parameter is as expected.
DtsInstanceId	String	No	dtsi03e3zty16i****	The ID of the data migration, synchronization, or tracking instance. Note Separate multiple instance IDs with commas (,). Make sure that the value of the JobType parameter is as expected.
ResourceGroupId	String	No	rg-acfmzawhxxc****	The ID of the resource group.
WithoutDbList	Boolean	No	true	Specifies whether to exclude the task object (the DbObject parameter) from the response. Valid values: true: Yes. The DbObject parameter is not included in the response. This can improve the response speed of the API call. false: No. The DbObject parameter is included in the response.
DtsBisLabel	String	No	normal	The environment tag of the DTS instance. Valid values: normal: Normal online: Online
ZeroEtlJob	Boolean	No	false	Specifies whether the task is a seamless integration (Zero-ETL) task. Valid values: false: No. true: Yes.
InstanceType	String	No	RDS	The type of the source or destination database instance.
InstanceId	String	No	rm-bp1966yuut4w3****	The ID of the source or destination database instance that corresponds to the InstanceType parameter.
DestProductType	String	No	RDS	The type of the destination database instance.
SrcProductType	String	No	RDS	The type of the source database instance.

Response parameters

Name	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	The ID of the request.
ErrCode	String	InternalError	The error code returned if the call fails.
Success	Boolean	true	Indicates whether the request was successful.
PageRecordCount	Integer	20	The maximum number of records that can be displayed on the current page.
TotalRecordCount	Integer	15	The total number of DTS instances that meet the criteria.
ErrMessage	String	The Value of Input Parameter %s is not valid.	The error message returned if the call fails.
DynamicMessage	String	Type	The dynamic error message that is used to replace the %s placeholder in the ErrMessage parameter. Note If ErrMessage returns The Value of Input Parameter %s is not valid and DynamicMessage returns Type, it means that the value of the Type parameter is invalid.
PageNumber	Integer	2	The page number.
DynamicCode	String	403	The dynamic error code. This parameter will be deprecated.
DtsJobList	Array of DtsJobStatus		The list of tasks and the execution details of each task.
Status	String	Migrating	The status of the DTS instance. Valid values: Data migration task statuses: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Migrating: The task is in progress. Suspending: The task is paused. MigrationFailed: The task failed. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded. Data synchronization task statuses: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Initializing: The task is initializing. InitializeFailed: The initialization failed. Synchronizing: The task is in progress. Failed: The task failed. Suspending: The task is paused. Modifying: The synchronization objects are being modified. ModifyFailed: Failed to modify the synchronization objects. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded. Data tracking task statuses: NotConfigured: The task is not configured. NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. Starting: The task is starting. Normal: The task is running as normal. Retrying: The task is being retried. Abnormal: The task is not running as expected. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded.
OriginType	String	DTS task	The source of the task: PTS task DMS task DTS task
DtsJobName	String	RDS-to-RDS migration	The name of the data migration, synchronization, or tracking task.
Delay	Long	0	The latency of incremental data migration or synchronization. Note The unit is milliseconds for data migration tasks and seconds for data synchronization tasks.
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 fails.
ExpireTime	String	2022-03-16T08:01:19Z	The expiration time of the instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note This parameter is returned only when the value of the PayType parameter is PrePaid.
DtsJobId	String	i03e3zty16i****	The ID of the data migration, synchronization, or tracking task.
CreateTime	String	2021-03-16T08:01:19Z	The time when the task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
PayType	String	PrePaid	The billing method of the instance. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go.
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, in a JSON string format. You can specify this parameter to implement special requirements, such as whether to automatically start a precheck. For more information, see MigrationReserved parameter description.
ConsumptionClient	String	114...:dts******	The information about the downstream client. It consists of an IP address and a random number generated by DTS.
DbObject	String	{"dtstestdata": { "name": "dtstestdata", "all": true }}	The objects of the data migration, synchronization, or tracking task. For more information about the definition, see Objects of data migration, data synchronization, and data tracking tasks.
DtsJobClass	String	large	The instance class. Note For more information about the specifications and performance of each instance class, see Data migration instance classes and Data synchronization instance classes.
ConsumptionCheckpoint	String	2021-03-23T07:30:31Z	The consumption checkpoint of the downstream client for the tracking task. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
EndTimestamp	String	2021-03-26T14:03:21Z	The end of the timestamp range for the data stored in the tracking instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
AppName	String	new	Indicates whether it is a new version of the tracking task. new indicates a new version. Note This parameter is returned only for new versions of tracking instances.
BeginTimestamp	String	2021-03-15T08:25:34Z	The start of the timestamp range for the data stored in the tracking instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
DtsInstanceID	String	dtsi03e3zty16i****	The ID of the data migration, synchronization, or tracking instance.
DtsJobDirection	String	Forward	The synchronization direction. Valid values: Forward: Forward. Reverse: Reverse. Note This parameter is returned only when the topology of the data synchronization instance is bidirectional.
Checkpoint	String	1616899019	The start offset or the synchronization point of incremental data migration. The value is a UNIX timestamp. Unit: seconds.
TagList	Array of DtsTag		The collection of tags.
TagValue	String	testvalue	The value of the tag.
TagKey	String	testkey	The key of the tag.
DataInitializationStatus	Object		The status of full data migration or initialization.
Status	String	Finished	The status of full data migration or initialization. Valid values: NotStarted: The task is not started. Migrating: The task is in progress. Failed: The task failed. Finished: The task is finished.
Percent	String	100	The progress of full data migration or initialization. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the full data migration or initialization fails.
Progress	String	44755	The number of records that have been migrated or initialized.
DataSynchronizationStatus	Object		The status of incremental data migration or synchronization.
Status	String	Catched	The status 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 finished. Catched: The task has no latency.
NeedUpgrade	Boolean	true	Indicates whether the instance class needs to be upgraded. Valid values: true: Yes. false: No. Note To upgrade the instance class, call the TransferInstanceClass operation.
Percent	String	95	The progress of incremental data migration or synchronization. Unit: percent.
Progress	String	0/0	The number of records that have been migrated or synchronized.
ErrorMessage	String	The task failed for too long and cannot be recovered.	The error message returned if the incremental data migration or synchronization fails.
DataEtlStatus	Object		The status of the ETL task. Note This parameter collection is returned only after you configure an ETL task.
Status	String	Finished	The status 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 finished. Catched: The task has no latency.
Percent	String	95	The progress of the ETL task. Unit: percent.
ErrorMessage	String	The task failed for too long and cannot be recovered.	The error message returned if the ETL task fails.
Progress	String	0/0	The number of records processed by the ETL task.
DestinationEndpoint	Object		The connection information of the destination instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the destination instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the destination instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the migration object in the destination instance belongs.
Ip	String	172.16.88.***	The endpoint of the destination instance.
InstanceID	String	rm-bp1imrtn6fq7h****	The ID of the destination instance.
Port	String	3306	The database service port of the destination instance.
InstanceType	String	RDS	The type of the destination instance.
UserName	String	dtstest	The database account of the destination instance.
EngineName	String	MySQL	The database type of the destination instance.
MigrationMode	Object		The migration type or initial synchronization type.
DataInitialization	Boolean	true	Indicates whether to perform full data migration or initial full data synchronization. Valid values: true: Yes. false: No.
DataSynchronization	Boolean	true	Indicates whether to perform incremental data migration or synchronization. Valid values: true: Yes. false: No.
StructureInitialization	Boolean	true	Indicates whether to perform schema migration or initial schema synchronization. Valid values: true: Yes. false: No.
FullDataCheck	Boolean	true	Indicates whether to perform full data verification. Valid values: true: Yes. false: No.
IncDataCheck	Boolean	true	Indicates whether to perform incremental data verification. Valid values: true: Yes. false: No.
StructureDataCheck	Boolean	true	Indicates whether to perform schema verification. Valid values: true: Yes. false: No.
Performance	Object		The performance information of the migration or synchronization link.
Rps	String	100	The number of SQL statements migrated or synchronized per second. This includes BEGIN, COMMIT, DML statements (INSERT, DELETE, and UPDATE), and DDL statements.
Flow	String	1	The data traffic migrated or synchronized per second. Unit: MB/s.
PrecheckStatus	Object		The precheck status.
Status	String	Finished	The precheck status. Valid values: NotStarted: The precheck is not started. Suspending: The precheck is paused. Checking: The precheck is in progress. Failed: The precheck failed. Finished: The precheck is finished.
Percent	String	100	The overall progress of the precheck. Unit: percent.
ErrorMessage	String	CHECK__ERROR_SAME_OBJ.	The error message returned if the precheck fails.
Detail	Array of PrecheckDetail		The execution status of each precheck item.
CheckResult	String	Success	The check result. Valid values: Success: The check passed. Failed: The check failed.
CheckItemDescription	String	CHECK_CONN_SRC_DETAIL	The description of the precheck item.
CheckItem	String	CHECK_CONN_SRC	The precheck item.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	The repair method for the failed precheck item. Note This parameter is returned only when the value of the CheckResult parameter is Failed.
FailedReason	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	The error message for the failed precheck item. Note This parameter is returned only when the value of the CheckResult parameter is Failed.
ReverseJob	Object		The execution details of the remote sync task. Note This parameter collection is returned only when the task is a data synchronization task and the topology is bidirectional.
Status	String	Synchronizing	The status of the remote sync task. Valid values: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Initializing: The task is initializing. InitializeFailed: The initialization failed. Synchronizing: The task is in progress. Failed: The task failed. Suspending: The task is paused. Modifying: The synchronization objects are being modified. ModifyFailed: Failed to modify the synchronization objects. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded.
DtsJobName	String	RDS-to-RDS migration	The name of the sync task.
Delay	Long	0	The latency of incremental data synchronization. Unit: seconds.
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 fails.
DtsJobId	String	i03e3zty16i****	The ID of the sync task.
ExpireTime	String	2023-03-16T08:01:19Z	The expiration time of the instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note This parameter is returned only when the value of the PayType parameter is PrePaid.
CreateTime	String	2022-03-16T08:01:19Z	The time when the task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
PayType	String	PostPaid	The billing method of the instance. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go.
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, in a JSON string format. You can specify this parameter to implement special requirements, such as whether to automatically start a precheck. For more information, see MigrationReserved parameter description.
DbObject	String	{"dtstestdata": { "name": "dtstestdata", "all": true }}	The definition of the table schema of the synchronization object. The value is a JSON string and supports regular expressions. For more information and examples, see Objects of data migration, data synchronization, and data tracking tasks.
DtsJobClass	String	large	The instance class. Note For more information about the specifications and performance of each instance class, see Data synchronization instance classes.
DtsInstanceID	String	dtsi03e3zty16i****	The ID of the sync instance.
DtsJobDirection	String	Reverse	The synchronization direction. The value is fixed at Reverse.
Checkpoint	String	1616980369	The offset of incremental data synchronization. The value is a UNIX timestamp. Unit: seconds.
DataInitializationStatus	Object		The status of initial full data synchronization.
Status	String	Finished	The status of initial 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 finished.
Percent	String	100	The progress of initial full data synchronization. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the initial full data synchronization fails.
Progress	String	43071	The number of records that have been initialized.
DataSynchronizationStatus	Object		The status of incremental data synchronization.
Status	String	Migrating	The status of incremental data synchronization.
NeedUpgrade	Boolean	true	Indicates whether the instance class needs to be upgraded. Valid values: true: Yes. false: No. Note To upgrade the instance class, call the TransferInstanceClass operation.
Percent	String	100	The progress of incremental data synchronization. Unit: percent.
Progress	String	20001	The number of records that have been migrated or synchronized.
ErrorMessage	String	The task failed for too long and cannot be recovered.	The error message returned if the incremental data synchronization fails.
DestinationEndpoint	Object		The connection information of the destination instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the destination instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the destination instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the synchronization object in the destination instance belongs.
Ip	String	172.16.88.***	The endpoint of the destination instance.
InstanceID	String	rm-bp1162kryivb8****	The ID of the destination instance.
Port	String	3306	The database service port of the destination instance.
InstanceType	String	RDS	The type of the destination instance.
UserName	String	dtstest	The database account of the destination instance.
EngineName	String	MySQL	The database type of the destination instance.
MigrationMode	Object		The initial synchronization type.
DataInitialization	Boolean	true	Indicates whether to perform initial full data synchronization. Valid values: true: Yes. false: No.
DataSynchronization	Boolean	true	Indicates whether to perform incremental data synchronization. Valid values: true: Yes. false: No.
StructureInitialization	Boolean	true	Indicates whether to perform initial schema synchronization. Valid values: true: Yes. false: No.
FullDataCheck	Boolean	true	Indicates whether to perform full data verification. Valid values: true: Yes. false: No.
IncDataCheck	Boolean	true	Indicates whether to perform incremental data verification. Valid values: true: Yes. false: No.
StructureDataCheck	Boolean	true	Indicates whether to perform schema verification. Valid values: true: Yes. false: No.
Performance	Object		The performance information of the synchronization link.
Rps	String	100	The number of SQL statements synchronized per second. This includes BEGIN, COMMIT, DML statements (INSERT, DELETE, and UPDATE), and DDL statements.
Flow	String	1	The data traffic synchronized per second. Unit: MB/s.
PrecheckStatus	Object		The precheck status.
Status	String	Finished	The precheck status. Valid values: NotStarted: The precheck is not started. Suspending: The precheck is paused. Checking: The precheck is in progress. Failed: The precheck failed. Finished: The precheck is finished.
Percent	String	100	The overall progress of the precheck. Unit: percent.
ErrorMessage	String	CHECK__ERROR_SAME_OBJ.	The error message returned if the precheck fails.
Detail	Array of PrecheckDetail		The execution status of each precheck item.
CheckResult	String	Success	The check result. Valid values: Success: The check passed. Failed: The check failed.
CheckItemDescription	String	CHECK_CONN_SRC_DETAIL	The description of the precheck item.
CheckItem	String	CHECK_CONN_SRC	The precheck item.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	The repair method for the failed precheck item.
FailedReason	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	The error message for the failed precheck item.
SourceEndpoint	Object		The connection information of the source instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the source instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the source instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the migration object in the source instance belongs.
Ip	String	172.16.88.***	The endpoint of the source instance.
InstanceID	String	rm-bp1imrtn6fq7h****	The ID of the source instance.
Port	String	3306	The database service port of the source instance.
InstanceType	String	RDS	The type of the source instance.
UserName	String	dtstest	The database account of the source instance.
EngineName	String	MySQL	The database type of the source instance.
StructureInitializationStatus	Object		The status of initial schema synchronization.
Status	String	Finished	The status of initial schema synchronization. Valid values: NotStarted: The task is not started. Migrating: The task is in progress. Failed: The task failed. Finished: The task is finished.
Percent	String	100	The progress of initial schema synchronization. Unit: percent.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	The error message returned if the initial schema synchronization fails.
Progress	String	1	The number of tables whose schemas have been initialized.
DuUsage	Long	15	The amount of resources used in the DTS dedicated cluster. Unit: DU.
CpuUsage	String	90	The current CPU utilization of the instance. Unit: %.
MemUsage	String	500	The used memory. Unit: MB.
DedicatedClusterId	String	dtscluster_dpwl3**********	The ID of the DTS dedicated cluster.
ErrorDetails	Array of ErrorDetail		The error details.
ErrorCode	String	DTS-31009	The error code.
HelpUrl	String	https://.ali.com/**	The URL of the help document.
EtlSafeCheckpoint	String	1610540493	The safe offset of the ETL task.
MinDu	double	1	The lower limit of DUs for the serverless instance.
MaxDu	double	16	The upper limit of DUs for the serverless instance.
FullDataCheckStatus	Object		The status of full data verification.
Status	String	Checking	The status of the full data verification task. Valid values: NotStarted: The task is not started. Checking: The task is in progress. Failed: The task failed. Finished: The task is finished. Inconsistency: Data inconsistency was detected.
Percent	String	100	The progress of the full data verification task. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the task fails.
Progress	String	1 rows/s (row: 5/5, table: 1/1)	The progress of the full data verification task.
CanSwitch	Boolean	false	Indicates whether the migration can be switched. Valid values: true: Yes. false: No. Note This parameter is used for the one-click upgrade feature of PolarDB.
IncDataCheckStatus	Object		The status of incremental data verification.
Status	String	Checking	The status of the incremental data verification task. Valid values: Catched: The task has no latency. NotStarted: The task is not started. Checking: The task is in progress. Failed: The task failed. Inconsistency: Data inconsistency was detected.
Percent	String	95	The progress of the incremental data verification task. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the task fails.
Progress	String	1 rows/s (row: 5/5, table: 1/1)	The progress of the incremental data verification task.
StructureDataCheckStatus	Object		The status of schema verification.
Status	String	Finished	The status of the schema verification task. Valid values: NotStarted: The task is not started. Checking: The task is in progress. Failed: The task failed. Finished: The task is finished. Inconsistency: Data inconsistency was detected.
Percent	String	100	The progress of the schema verification task. Unit: percent.
ErrorMessage	String	****	The error message returned if the task fails.
Progress	String	5	The number of objects whose schemas have been verified.
SourceEndpoint	Object		The connection information of the source instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the source instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the source instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the migration object in the source instance belongs.
Ip	String	172.16.88.***	The endpoint of the source instance.
InstanceID	String	rm-bp1162kryivb8****	The ID of the source instance.
Port	String	3306	The database service port of the source instance.
InstanceType	String	RDS	The type of the source instance.
UserName	String	dtstest	The database account of the source instance.
EngineName	String	MySQL	The database type of the source instance.
StructureInitializationStatus	Object		The status of schema migration or initialization.
Status	String	Finished	The status of schema migration or initialization. Valid values: NotStarted: The task is not started. Migrating: The task is in progress. Failed: The task failed. Finished: The task is finished.
Percent	String	100	The progress of schema migration or initialization. Unit: percent.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	The error message returned if the schema migration or initialization fails.
Progress	String	1	The number of tables whose schemas have been migrated or initialized.
RetryState	Object		DTS is retrying the task because an exception occurred.
RetryCount	Integer	5	The number of retries.
MaxRetryTime	Integer	7200	The maximum duration of a retry. Unit: seconds.
ErrMessage	String	Unexpected error	The error message returned if the retry fails.
RetryTarget	String	srcDB	The retry target. Valid values: srcDB: Source database. destDB: Destination database. inner_module: DTS internal module.
RetryTime	Integer	3600	The duration of the retry. Unit: seconds.
Module	String	03	The progress of the instance.
JobId	String	bi6e22ay243****	The task ID.
Retrying	Boolean	false	Indicates whether the task is being retried. Valid values: true: Yes. false: No.
MigrationErrHelpDocId	String	462133	The ID of the help document for the error code.
MigrationErrHelpDocKey	String	DTS-RETRY-ERR-0046	The key of the help document for the error code.
MigrationErrCode	String	dts.retry.err.0046	The code of the error.
MigrationErrType	String	ForeignKey	The type of the error.
MigrationErrMsg	String	dts.retry.err.0046.msg	The error message.
MigrationErrWorkaround	String	dts.retry.err.0046.workaround	The solution to the error.
JobType	String	online	The type of the DTS task. Valid values: online: Data migration. sync: Data synchronization. subscribe: Data tracking.
DuUsage	Long	15	The amount of resources used in the DTS dedicated cluster. Unit: DU.
CpuUsage	String	1	The current CPU utilization of the instance. Unit: %.
MemUsage	String	500	The used memory. Unit: MB.
DedicatedClusterId	String	dtscluster_ft7y3**********	The ID of the DTS dedicated cluster.
ErrorDetails	Array of ErrorDetail		The error details.
ErrorCode	String	DTS-31009	The error code.
HelpUrl	String	https://.ali.com/**	The URL of the help document.
DataCloudStatus	Object		The process status of the physical migration task.
Status	String	Migrating	The status of the task. For more information, see the description of the Status request parameter.
NeedUpgrade	Boolean	false	Indicates whether the instance class needs to be upgraded. Valid values: true: Yes. false: No.
Percent	String	85	The progress of the task. Unit: percent.
Progress	String	1	The number of tables that have been migrated.
ErrorMessage	String	framework: DTS-31009: In process of processing data ****	The error message returned if the task fails.
ResourceGroupId	String	rg-acfmzawhxxc****	The ID of the resource group.
ResourceGroupDisplayName	String	default resource group	The name of the resource group.
MigrationErrMsg	String	dts.retry.err.0046.msg	The error message.
MigrationErrHelpDocId	String	462133	The ID of the help document for the error code.
MigrationErrWorkaround	String	dts.retry.err.0046.workaround	The solution to the error.
MigrationErrCode	String	dts.retry.err.0046	The code of the error.
MigrationErrHelpDocKey	String	DTS-RETRY-ERR-0046	The key of the help document for the error code.
MigrationErrType	String	ForeignKey	The type of the error.
EtlSafeCheckpoint	String	1610540493	The safe offset of the ETL task.
FullDataCheckStatus	Object		The status of full data verification.
Status	String	Checking	The status of the full data verification task. Valid values: NotStarted: The task is not started. Checking: The task is in progress. Failed: The task failed. Finished: The task is finished.
Percent	String	100	The progress of the full data verification task. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the task fails.
Progress	String	1 rows/s (row: 5/5, table: 1/1)	The progress of the full data verification task.
CanSwitch	Boolean	false	Indicates whether the migration can be switched. Valid values: true: Yes. false: No. Note This parameter is used for the one-click upgrade feature of PolarDB.
IncDataCheckStatus	Object		The status of incremental data verification.
Status	String	Checking	The status of the incremental data verification task. Valid values: Catched: The task has no latency. NotStarted: The task is not started. Checking: The task is in progress. Failed: The task failed.
Percent	String	95	The progress of the incremental data verification task. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the task fails.
Progress	String	1 rows/s (row: 5/5, table: 1/1)	The progress of the incremental data verification task.
DtsBisLabel	String	normal	The environment tag of the DTS instance. Valid values: normal: Normal online: Online
MinDu	double	1	The lower limit of DUs for the serverless instance.
MaxDu	double	16	The upper limit of DUs for the serverless instance.
DuRealUsage	String	12.0%	The DU usage of the dedicated cluster task.
StructureDataCheckStatus	Object		The status of schema verification.
Status	String	Finished	The status of the schema verification task. Valid values: NotStarted: The task is not started. Checking: The task is in progress. Failed: The task failed. Finished: The task is finished. Inconsistency: Data inconsistency was detected.
Percent	String	100	The progress of the schema verification task. Unit: percent.
ErrorMessage	String	****	The error message returned if the task fails.
Progress	String	5	The number of objects whose schemas have been verified.
EtlDemoList	Array of DtsJobStatus		The list of tasks and the execution details of each task.
Status	String	Migrating	The status of the DTS instance. Valid values: Data migration task statuses: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Migrating: The task is in progress. Suspending: The task is paused. MigrationFailed: The task failed. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded. Data synchronization task statuses: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Initializing: The task is initializing. InitializeFailed: The initialization failed. Synchronizing: The task is in progress. Failed: The task failed. Suspending: The task is paused. Modifying: The synchronization objects are being modified. ModifyFailed: Failed to modify the synchronization objects. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded. Data tracking task statuses: NotConfigured: The task is not configured. NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. Starting: The task is starting. Normal: The task is running as normal. Retrying: The task is being retried. Abnormal: The task is not running as expected. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded.
OriginType	String	DTS task	The source of the annotated task: PTS task DMS task DTS task
DtsJobName	String	RDS-to-RDS migration	The name of the data migration, synchronization, or tracking task.
Delay	Long	0	The latency of incremental data migration or synchronization. Note The unit is milliseconds for data migration tasks and seconds for data synchronization tasks.
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 fails.
ExpireTime	String	2022-03-16T08:01:19Z	The expiration time of the instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note This parameter is returned only when the value of the PayType parameter is PrePaid.
DtsJobId	String	i03e3zty16i****	The ID of the data migration, synchronization, or tracking task.
CreateTime	String	2021-03-16T08:01:19Z	The time when the task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
PayType	String	PrePaid	The billing method of the instance. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go.
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, in a JSON string format. You can specify this parameter to implement special requirements, such as whether to automatically start a precheck. For more information, see MigrationReserved parameter description.
ConsumptionClient	String	114...:dts******	The information about the downstream client. It consists of an IP address and a random number generated by DTS.
DbObject	String	{"dtstestdata": { "name": "dtstestdata", "all": true }}	The objects of the data migration, synchronization, or tracking task. For more information about the definition, see Objects of data migration, data synchronization, and data tracking tasks.
DtsJobClass	String	large	The instance class. Note For more information about the specifications and performance of each instance class, see Data migration instance classes and Data synchronization instance classes.
ConsumptionCheckpoint	String	2021-03-23T07:30:31Z	The consumption checkpoint of the downstream client for the tracking task. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
EndTimestamp	String	2021-03-26T14:03:21Z	The end of the timestamp range for the data stored in the tracking instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
AppName	String	new	Indicates whether it is a new version of the tracking task. new indicates a new version. Note This parameter is returned only for new versions of tracking instances.
BeginTimestamp	String	2021-03-15T08:25:34Z	The start of the timestamp range for the data stored in the tracking instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
DtsInstanceID	String	dtsi03e3zty16i****	The ID of the data migration, synchronization, or tracking instance.
DtsJobDirection	String	Forward	The synchronization direction. Valid values: Forward: Forward. Reverse: Reverse. Note This parameter is returned only when the topology of the data synchronization instance is bidirectional.
Checkpoint	String	1616899019	The start offset or the synchronization point of incremental data migration. The value is a UNIX timestamp. Unit: seconds.
TagList	Array of DtsTag		The collection of tags.
TagValue	String	testvalue	The value of the tag.
TagKey	String	testkey	The key of the tag.
DataInitializationStatus	Object		The status of full data migration or initialization.
Status	String	Finished	The status of full data migration or initialization. Valid values: NotStarted: The task is not started. Migrating: The task is in progress. Failed: The task failed. Finished: The task is finished.
Percent	String	100	The progress of full data migration or initialization. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the full data migration or initialization fails.
Progress	String	44755	The number of records that have been migrated or initialized.
DataSynchronizationStatus	Object		The status of incremental data migration or synchronization.
Status	String	Catched	The status 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 finished. Catched: The task has no latency.
NeedUpgrade	Boolean	true	Indicates whether the instance class needs to be upgraded. Valid values: true: Yes. false: No. Note To upgrade the instance class, call the TransferInstanceClass operation.
Percent	String	95	The progress of incremental data migration or synchronization. Unit: percent.
Progress	String	0/0	The number of records that have been migrated or synchronized.
ErrorMessage	String	The task failed for too long and cannot be recovered.	The error message returned if the incremental data migration or synchronization fails.
DataEtlStatus	Object		The status of the ETL task. Note This parameter collection is returned only after you configure an ETL task.
Status	String	Finished	The status 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 finished. Catched: The task has no latency.
Percent	String	95	The progress of the ETL task. Unit: percent.
ErrorMessage	String	The task failed for too long and cannot be recovered.	The error message returned if the ETL task fails.
Progress	String	0/0	The number of records processed by the ETL task.
DestinationEndpoint	Object		The connection information of the destination instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the destination instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the destination instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the migration object in the destination instance belongs.
Ip	String	172.16.88.***	The endpoint of the destination instance.
InstanceID	String	rm-bp1imrtn6fq7h****	The ID of the destination instance.
Port	String	3306	The database service port of the destination instance.
InstanceType	String	RDS	The type of the destination instance.
UserName	String	dtstest	The database account of the destination instance.
EngineName	String	MySQL	The database type of the destination instance.
MigrationMode	Object		The migration type or initial synchronization type.
DataInitialization	Boolean	true	Indicates whether to perform full data migration or initial full data synchronization. Valid values: true: Yes. false: No.
DataSynchronization	Boolean	true	Indicates whether to perform incremental data migration or synchronization. Valid values: true: Yes. false: No.
StructureInitialization	Boolean	true	Indicates whether to perform schema migration or initial schema synchronization. Valid values: true: Yes. false: No.
Performance	Object		The performance information of the migration or synchronization link.
Rps	String	100	The number of SQL statements migrated or synchronized per second. This includes BEGIN, COMMIT, DML statements (INSERT, DELETE, and UPDATE), and DDL statements.
Flow	String	1	The data traffic migrated or synchronized per second. Unit: MB/s.
PrecheckStatus	Object		The precheck status.
Status	String	Finished	The precheck status. Valid values: NotStarted: The precheck is not started. Suspending: The precheck is paused. Checking: The precheck is in progress. Failed: The precheck failed. Finished: The precheck is finished.
Percent	String	100	The overall progress of the precheck. Unit: percent.
ErrorMessage	String	CHECK__ERROR_SAME_OBJ.	The error message returned if the precheck fails.
Detail	Array of PrecheckDetail		The execution status of each precheck item.
CheckResult	String	Success	The check result. Valid values: Success: The check passed. Failed: The check failed.
CheckItemDescription	String	CHECK_CONN_SRC_DETAIL	The description of the precheck item.
CheckItem	String	CHECK_CONN_SRC	The precheck item.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	The repair method for the failed precheck item. Note This parameter is returned only when the value of the CheckResult parameter is Failed.
FailedReason	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	The error message for the failed precheck item. Note This parameter is returned only when the value of the CheckResult parameter is Failed.
ReverseJob	Object		The execution details of the remote sync task. Note This parameter collection is returned only when the task is a data synchronization task and the topology is bidirectional.
Status	String	Synchronizing	The status of the remote sync task. Valid values: NotStarted: The task is not started. Prechecking: The task is in precheck. PrecheckFailed: The precheck failed. PreCheckPass: The precheck passed. NotConfigured: The task is not configured. Initializing: The task is initializing. InitializeFailed: The initialization failed. Synchronizing: The task is in progress. Failed: The task failed. Suspending: The task is paused. Modifying: The synchronization objects are being modified. ModifyFailed: Failed to modify the synchronization objects. Finished: The task is finished. Retrying: The task is being retried. Upgrade: The instance is being upgraded. Locked: The instance is locked. Downgrade: The instance is being downgraded.
DtsJobName	String	RDS-to-RDS migration	The name of the sync task.
Delay	Long	0	The latency of incremental data synchronization. Unit: seconds.
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 fails.
DtsJobId	String	i03e3zty16i****	The ID of the sync task.
ExpireTime	String	2022-03-16T08:01:19Z	The expiration time of the instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note This parameter is returned only when the value of the PayType parameter is PrePaid.
CreateTime	String	2021-03-16T08:01:19Z	The time when the task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
PayType	String	PostPaid	The billing method of the instance. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go.
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, in a JSON string format. You can specify this parameter to implement special requirements, such as whether to automatically start a precheck. For more information, see MigrationReserved parameter description.
DbObject	String	{"dtstestdata": { "name": "dtstestdata", "all": true }}	The definition of the table schema of the synchronization object. The value is a JSON string and supports regular expressions. For more information and examples, see Objects of data migration, data synchronization, and data tracking tasks.
DtsJobClass	String	large	The instance class. Note For more information about the specifications and performance of each instance class, see Data synchronization instance classes.
DtsInstanceID	String	dtsi03e3zty16i****	The ID of the sync instance.
DtsJobDirection	String	Reverse	The synchronization direction. The value is fixed at Reverse.
Checkpoint	String	1616980369	The offset of incremental data synchronization. The value is a UNIX timestamp. Unit: seconds.
DataInitializationStatus	Object		The status of initial full data synchronization.
Status	String	Finished	The status of initial 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 finished.
Percent	String	100	The progress of initial full data synchronization. Unit: percent.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if the initial full data synchronization fails.
Progress	String	43071	The number of records that have been initialized.
DataSynchronizationStatus	Object		The status of incremental data synchronization.
Status	String	Migrating	The status of incremental data synchronization.
NeedUpgrade	Boolean	true	Indicates whether the instance class needs to be upgraded. Valid values: true: Yes. false: No. Note To upgrade the instance class, call the TransferInstanceClass operation.
Percent	String	100	The progress of incremental data synchronization. Unit: percent.
Progress	String	20001	The number of records that have been migrated or synchronized.
ErrorMessage	String	The task failed for too long and cannot be recovered.	The error message returned if the incremental data synchronization fails.
DestinationEndpoint	Object		The connection information of the destination instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the destination instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the destination instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the synchronization object in the destination instance belongs.
Ip	String	172.16.88.***	The endpoint of the destination instance.
InstanceID	String	rm-bp1162kryivb8****	The ID of the destination instance.
Port	String	3306	The database service port of the destination instance.
InstanceType	String	RDS	The type of the destination instance.
UserName	String	dtstest	The database account of the destination instance.
EngineName	String	MySQL	The database type of the destination instance.
MigrationMode	Object		The migration type or initial synchronization type.
DataInitialization	Boolean	true	Indicates whether to perform full data migration or initial full data synchronization. Valid values: true: Yes. false: No.
DataSynchronization	Boolean	true	Indicates whether to perform incremental data migration or synchronization. Valid values: true: Yes. false: No.
StructureInitialization	Boolean	true	Indicates whether to perform schema migration or initial schema synchronization. Valid values: true: Yes. false: No.
Performance	Object		The performance information of the migration or synchronization link.
Rps	String	100	The number of SQL statements migrated or synchronized per second. This includes BEGIN, COMMIT, DML statements (INSERT, DELETE, and UPDATE), and DDL statements.
Flow	String	1	The data traffic migrated or synchronized per second. Unit: MB/s.
PrecheckStatus	Object		The precheck status.
Status	String	Finished	The precheck status. Valid values: NotStarted: The precheck is not started. Suspending: The precheck is paused. Checking: The precheck is in progress. Failed: The precheck failed. Finished: The precheck is finished.
Percent	String	100	The overall progress of the precheck. Unit: percent.
ErrorMessage	String	CHECK__ERROR_SAME_OBJ	The error message returned if the precheck fails.
Detail	Array of PrecheckDetail		The execution status of each precheck item.
CheckResult	String	Success	The check result. Valid values: Success: The check passed. Failed: The check failed.
CheckItemDescription	String	CHECK_CONN_SRC_DETAIL	The description of the precheck item.
CheckItem	String	CHECK_CONN_SRC	The precheck item.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	The repair method for the failed precheck item. Note This parameter is returned only when the value of the CheckResult parameter is Failed.
FailedReason	String	Original error: Access denied for user 'dtstest'@'100.104.XXX.XX' (using password: YES)	The error message for the failed precheck item. Note This parameter is returned only when the value of the CheckResult parameter is Failed.
SourceEndpoint	Object		The connection information of the source instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the source instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the source instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the migration object in the source instance belongs.
Ip	String	172.16.XX.XX	The endpoint of the source instance.
InstanceID	String	rm-bp1imrtn6fq7h****	The ID of the source instance.
Port	String	3306	The database service port of the source instance.
InstanceType	String	RDS	The type of the source instance.
UserName	String	dtstest	The database account of the source instance.
EngineName	String	MySQL	The database type of the source instance.
StructureInitializationStatus	Object		The status of initial schema synchronization.
Status	String	Finished	The status of initial schema synchronization. Valid values: NotStarted: The task is not started. Migrating: The task is in progress. Failed: The task failed. Finished: The task is finished.
Percent	String	100	The progress of initial schema synchronization. Unit: percent.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	The error message returned if the initial schema synchronization fails.
Progress	String	1	The number of tables whose schemas have been initialized.
EtlSafeCheckpoint	String	161054****	The safe offset of the ETL task.
SourceEndpoint	Object		The connection information of the source instance.
SslSolutionEnum	String	DISABLE	Indicates whether to use an SSL-encrypted connection. Valid values: DISABLE: Do not use an SSL-encrypted connection. ENABLE_WITH_CERTIFICATE: Use an SSL-encrypted connection and upload a CA certificate. ENABLE_ONLY_4_MONGODB_ALTAS: Use an SSL-encrypted connection to connect to an AWS MongoDB Atlas database. ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: Use SCRAM-SHA-256 to connect to a Kafka instance.
OracleSID	String	testsid	The system ID (SID) of the Oracle database. Note This parameter is returned only when the EngineName of the source instance is set to Oracle and the Oracle database is not a Real Application Clusters (RAC) instance.
Region	String	cn-hangzhou	The region where the source instance resides. For more information, see Supported regions.
DatabaseName	String	dtstestdata	The name of the database to which the migration object in the source instance belongs.
Ip	String	172.16.88.***	The endpoint of the source instance.
InstanceID	String	rm-bp1162kryivb8****	The ID of the source instance.
Port	String	3306	The database service port of the source instance.
InstanceType	String	RDS	The type of the source instance.
UserName	String	dtstest	The database account of the source instance.
EngineName	String	MySQL	The database type of the source instance.
StructureInitializationStatus	Object		The status of schema migration or initialization.
Status	String	Finished	The status of schema migration or initialization. Valid values: NotStarted: The task is not started. Migrating: The task is in progress. Failed: The task failed. Finished: The task is finished.
Percent	String	100	The progress of schema migration or initialization. Unit: percent.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	The error message returned if the schema migration or initialization fails.
Progress	String	1	The number of tables whose schemas have been migrated or initialized.
RetryState	Object		DTS is retrying the task because an exception occurred.
RetryCount	Integer	5	The number of retries.
MaxRetryTime	Integer	7200	The maximum duration of a retry. Unit: seconds.
ErrMessage	String	Unexpected error	The error message returned if the retry fails.
RetryTarget	String	srcDB	The retry target. Valid values: srcDB: Source database. destDB: Destination database. inner_module: DTS internal module.
RetryTime	Integer	3600	The duration of the retry. Unit: seconds.
Module	String	03	The progress of the instance.
JobId	String	bi6e22ay243****	The task ID.
Retrying	Boolean	false	Indicates whether the task is being retried. Valid values: true: Yes. false: No.
JobType	String	online	The type of the DTS instance task. Valid values: online: Data migration. sync: Data synchronization. subscribe: Data tracking.
ResourceGroupId	String	rg-acfmzawhxxc****	The ID of the resource group.
ResourceGroupDisplayName	String	default resource group	The name of the resource group.
EtlSafeCheckpoint	String	161054****	The safe offset of the ETL task.

Examples

Request example

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<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/>
            <DataInitializationStatus/>
            <DestinationEndpoint/>
            <SourceEndpoint/>
            <Performance/>
            <MigrationMode/>
            <StructureInitializationStatus/>
            <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/>
            <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/>
        <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

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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

HttpCode	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	The request was rejected because the request frequency reached the limit. Try again later.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The signature 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 request fails again, contact technical support.

For more information about error codes, see the Error Center.