Queries the details of a data migration, data synchronization, or change tracking 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 DescribeDtsJobDetail

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

DtsJobId String Yes ta7w132u12h****

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

DtsInstanceID String No dtsta7w132u12h****

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

SynchronizationDirection String No Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse
Note
  • Default value: Forward.
  • The value Reverse takes effect only if the topology of the data synchronization instance is two-way synchronization.
RegionId String No cn-hangzhou

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

Response parameters

Parameter Type Example Description
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 Integer 1616405159

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

Code Integer 200

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

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.

DatabaseCount Integer 2

The number of ApsaraDB RDS for MySQL instances that are attached to the source PolarDB-X V1.0 instance.

DbObject String {\"dtstestdata\":{\"all\":true,\"name\":\"dtstestdata\",\"state\":\"normal\"}}

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

Delay Integer 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.
DestNetType String CLASSIC

The network type of the consumer client. Valid values:

  • CLASSIC
  • VPC
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 with an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection with 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 xlarge

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 API test

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

DynamicMessage String DtsJobId

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 DtsJobId, the specified DtsJobId parameter is invalid.
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.

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.

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.

EtlCalculator String { "cells ": [{\"shape\":\"edge\",\"attrs\":{\"line\":{\"stroke\":\"#b1b1b1\",\"strokeWidth\":1,\"targetMarker\":{\"name\":\"block\",\"args\":{\"size\":\"8\"}},\"strokeDasharray\":\"\"}},\"id\":\"cd1ec473-f9b9-4e9b-a742-ac23f44299e1\",\"source\":{\"cell\":\"8b261182-bfab-4803-ad8e-6bb08e3e0a99\",\"port\":\"out1\"},\"target\":{\"cell\":\"b36770df-f48c-4d6b-9644-54c5e9242987\",\"port\":\"in1\"},\"zIndex\":7 }] }

The operator information of the ETL task.

Note This parameter is returned only when you query the details of an ETL task.
ExpireTime String 2021-06-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.
FinishTime String 2021-03-16T10:34:17Z

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

GroupId String i03e3zty16i****

The ID of the DTS task.

HttpStatusCode Integer 200

The HTTP status code.

MigrationMode Struct

The migration types or synchronization types.

DataExtractTransformLoad Boolean false

Indicates whether data transformation is performed. Valid values:

  • true: yes
  • false: no
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 PrePaid

The billing method of the DTS instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
RequestId String 29207299-7C41-493A-BA4F-2FAC5DE4****

The ID of the request.

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.

AliyunUid String 140692647406****

The ID of the Alibaba Cloud account that owns the source RDS 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.

RoleName String ram-for-dts

The name of the RAM role configured for the Alibaba Cloud account that owns the source instance.

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 with an AWS MongoDB Altas database.
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256: SCRAM-SHA-256 is used to encrypt the connection with a Kafka cluster.
UserName String dtstest

The database account of the source instance.

Status String Migrating

The status of the data migration or data synchronization task.

Valid values for a data migration task:

  • NotStarted: The task is not started.
  • Migrating: The task is migrating data.
  • Failed: The task failed to migrate data.
  • Finished: The task is completed.

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.
  • Initializing: The task is performing initial synchronization.
  • InitializeFailed: Initial synchronization failed.
  • Synchronizing: The task is synchronizing data.
  • 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.
SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

The topic of the change tracking instance.

Note This parameter is returned only if your change tracking instances are of the new version and you have called the CreateConsumerGroup operation to create a consumer group.
SubscriptionDataType Struct

The types of operations that are tracked by the task.

Ddl Boolean true

Indicates whether data definition language (DDL) operations are tracked. Valid values:

  • true: yes
  • false: no
Dml Boolean true

Indicates whether data manipulation language (DML) operations are tracked. Valid values:

  • true: yes
  • false: no
SubscriptionHost Struct

The endpoint of the change tracking instance.

PrivateHost String dts-cn-****-internal.aliyuncs.com:18002

The private endpoint of the change tracking instance. The format is <Address>:<Port number>.

PublicHost String dts-cn-****.aliyuncs.com:18001

The public endpoint of the change tracking instance. The format is <Address>:<Port number>.

VpcHost String dts-cn-****-vpc.aliyuncs.com:18003

The virtual private cloud (VPC) endpoint of the change tracking instance. The format is <Address>:<Port number>.

Success Boolean true

Indicates whether the call was successful.

SynchronizationDirection String Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeDtsJobDetail
&DtsJobId=ta7w132u12h****
&<Common request parameters>

Sample success responses

XML format 

<DescribeDtsJobDetailResponse>
      <DtsJobName>API test</DtsJobName>
      <DtsInstanceID>dtsi03e3zty16i****</DtsInstanceID>
      <Success>true</Success>
      <Delay>0</Delay>
      <MigrationMode>
            <DataInitialization>true</DataInitialization>
            <DataSynchronization>true</DataSynchronization>
            <StructureInitialization>true</StructureInitialization>
      </MigrationMode>
      <DtsJobClass>xlarge</DtsJobClass>
      <DtsJobId>i03e3zty16i****</DtsJobId>
      <HttpStatusCode>200</HttpStatusCode>
      <Status>Migrating</Status>
      <RequestId>29207299-7C41-493A-BA4F-2FAC5DE4****</RequestId>
      <DbObject>{"dtstestdata":{"all":true,"name":"dtstestdata","state":"normal"}}</DbObject>
      <CreateTime>2021-03-16T08:01:19Z</CreateTime>
      <PayType>PostPaid</PayType>
      <Checkpoint>1616405159</Checkpoint>
      <DestinationEndpoint>
            <UserName>dtstest</UserName>
            <InstanceID>rm-bp1imrtn6fq7h****</InstanceID>
            <SslSolutionEnum>DISABLE</SslSolutionEnum>
            <Port>3306</Port>
            <DatabaseName>dtstestdata</DatabaseName>
            <Region>cn-hangzhou</Region>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </DestinationEndpoint>
      <SourceEndpoint>
            <RoleName></RoleName>
            <UserName>dtstest</UserName>
            <InstanceID>rm-bp1162kryivb8****</InstanceID>
            <SslSolutionEnum>DISABLE</SslSolutionEnum>
            <Port>3306</Port>
            <AliyunUid>140692647406****</AliyunUid>
            <Region>cn-hangzhou</Region>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </SourceEndpoint>
      <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**.**:1****","destVpcNetMappingInst":"172.16.1**.**:1****","useJobTask":"1"}</Reserved>
</DescribeDtsJobDetailResponse>

JSON format 

{
	"DtsJobName": "API test",
	"DtsInstanceID": "dtsi03e3zty16i****",
	"Success": true,
	"Delay": 0,
	"MigrationMode": {
		"DataInitialization": true,
		"DataSynchronization": true,
		"StructureInitialization": true
	},
	"DtsJobClass": "xlarge",
	"DtsJobId": "i03e3zty16i****",
	"HttpStatusCode": 200,
	"Status": "Migrating",
	"RequestId": "29207299-7C41-493A-BA4F-2FAC5DE4****",
	"DbObject": "{\"dtstestdata\":{\"all\":true,\"name\":\"dtstestdata\",\"state\":\"normal\"}}",
	"CreateTime": "2021-03-16T08:01:19Z",
	"PayType": "PostPaid",
	"Checkpoint": "1616405159",
	"DestinationEndpoint": {
		"UserName": "dtstest",
		"InstanceID": "rm-bp1imrtn6fq7h****",
		"SslSolutionEnum": "DISABLE",
		"Port": "3306",
		"DatabaseName": "dtstestdata",
		"Region": "cn-hangzhou",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"SourceEndpoint": {
		"RoleName": "",
		"UserName": "dtstest",
		"InstanceID": "rm-bp1162kryivb8****",
		"SslSolutionEnum": "DISABLE",
		"Port": "3306",
		"AliyunUid": "140692647406****",
		"Region": "cn-hangzhou",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"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**.**:1****\",\"destVpcNetMappingInst\":\"172.16.1**.**:1****\",\"useJobTask\":\"1\"}"
}

Error codes

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