调用DescribeDtsJobDetail查询一个数据迁移、同步或订阅任务的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDtsJobDetail

系统规定参数。取值:DescribeDtsJobDetail

DtsJobId String ta7w132u12h****

迁移、同步或订阅任务ID。

DtsInstanceID String dtsta7w132u12h****

迁移、同步或订阅实例ID。

SynchronizationDirection String Forward

同步方向,取值:

  • Forward:正向。
  • Reverse:反向。
说明
  • 默认取值为Forward
  • 只有当数据同步实例的同步拓扑为双向同步时,本参数传入Reverse才会生效。
RegionId String cn-hangzhou

任务所属地域ID,请参见支持的地域列表

返回数据

名称 类型 示例值 描述
AppName String new

是否为新版订阅,new(新版订阅)。

说明 该参数仅在新版订阅实例中返回。
BeginTimestamp String 2021-03-15T08:25:34Z

订阅实例中保存的数据范围的起始时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Checkpoint Integer 1616405159

增量数据迁移的启动位点或者同步位点,格式为Unix时间戳,单位为秒。

Code Integer 200

错误码,本参数即将下线。

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

订阅任务的下游消费时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

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

下游消费客户端信息,由IP地址和DTS随机生成的随机数组成。

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

任务创建时间,yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

DatabaseCount Integer 2

如源实例为PolarDB-X 1.0时,您需要输入其下挂RDS MySQL的数量。

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

迁移、同步或订阅对象,详细定义说明,请参见迁移、同步或订阅对象说明

Delay Integer 0

增量数据迁移或者同步的延迟时间。

说明 如查询迁移任务,该参数的单位为毫秒,如查询同步任务,该参数的单位为秒。
DestNetType String CLASSIC

消费客户端所属网络类型:

  • CLASSIC:经典网络。
  • VPC:专有网络。
DestinationEndpoint Struct

目标实例的连接信息。

DatabaseName String dtstestdata

目标实例中迁移对象所属数据库的名称。

EngineName String MySQL

目标实例的数据库类型。

InstanceID String rm-bp1imrtn6fq7h****

目标实例ID。

InstanceType String RDS

目标实例类型。

Ip String 172.16.88.***

目标实例的连接地址。

OracleSID String testsid

Oracle数据库的SID信息。

说明 当目标实例的 EngineName取值为 Oracle,且Oracle数据库为非RAC实例时,才会返回本参数。
Port String 3306

目标实例的数据库服务端口。

Region String cn-hangzhou

目标实例所在区域,详情请参见支持的地域列表

SslSolutionEnum String DISABLE

是否使用SSL安全连接,返回值:

  • DISABLE:不使用SSL安全连接。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全连接,并上传CA证书。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全连接AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256连接Kafka。
UserName String dtstest

目标实例的数据库账号。

DtsInstanceID String dtsi03e3zty16i****

迁移、同步或订阅实例ID。

DtsJobClass String xlarge

链路规格。

说明 关于各链路规格的说明及性能测试情况请参见 数据迁移链路规格说明数据同步链路规格说明
DtsJobDirection String Forward

同步方向,返回值:

  • Forward:正向。
  • Reverse:反向。
说明 当数据同步实例的拓扑为双向时,才会返回本参数。
DtsJobId String i03e3zty16i****

迁移、同步或订阅任务ID。

DtsJobName String api测试

迁移、同步或订阅任务名称。

DynamicMessage String DtsJobId

动态错误信息,用于替换返回参数ErrMessage错误信息中的%s

说明 如果 ErrMessage返回 The Value of Input Parameter %s is not valid,且 DynamicMessage返回 DtsJobId,则代表所传入的请求参数 DtsJobId不合法。
EndTimestamp String 2021-03-26T14:03:21Z

订阅实例中保存的数据范围的截止时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

ErrCode String InternalError

调用出错时返回的错误码。

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

调用错误时返回的错误信息。

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].

任务失败的错误提示。

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 }] }

ETL任务的算子信息。

说明 当任务为ETL时,才会返回本参数。
ExpireTime String 2021-06-16T08:01:19Z

实例的到期时间,yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明PayType参数的返回值为 PrePaid时才会返回本参数。
FinishTime String 2021-03-16T10:34:17Z

任务结束时间,yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

GroupId String i03e3zty16i****

DTS任务ID。

HttpStatusCode Integer 200

状态码。

MigrationMode Struct

迁移类型或同步初始化类型。

DataExtractTransformLoad Boolean false

是否执行数据加工,返回值:

  • true:是。
  • false:否。
DataInitialization Boolean true

是否执行全量数据迁移或全量数据初始化,返回值:

  • true:是。
  • false:否。
DataSynchronization Boolean true

是否执行增量数据迁移或同步,返回值:

  • true:是。
  • false:否。
StructureInitialization Boolean true

是否执行库表结构迁移或初始化,返回值:

  • true:是。
  • false:否。
PayType String PrePaid

实例的付费类型,返回值:

  • PrePaid:包年包月(预付费)。
  • PostPaid:按量付费(后付费)。
RequestId String 29207299-7C41-493A-BA4F-2FAC5DE4****

请求ID。

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\"}

DTS预留参数,格式为JSON串,您可以传入本参数实现特殊需求(例如是否自动启动预检查)。更多信息,请参见MigrationReserved参数说明

SourceEndpoint Struct

源实例连接信息。

AliyunUid String 140692647406****

源RDS实例所属的阿里云账号ID。

DatabaseName String dtstestdata

源实例中迁移对象所属数据库的名称。

EngineName String MySQL

源实例的数据库类型。

InstanceID String rm-bp1162kryivb8****

源实例ID。

InstanceType String RDS

源实例类型。

Ip String 172.16.88.***

源实例的连接地址。

OracleSID String testsid

Oracle数据库的SID信息。

说明 当源实例的 EngineName取值为 Oracle,且Oracle数据库为非RAC实例时,才会返回本参数。
Port String 3306

源实例的数据库服务端口。

Region String cn-hangzhou

源实例所在区域,详情请参见支持的地域列表

RoleName String ram-for-dts

源实例所属云账号配置的角色名称。

SslSolutionEnum String DISABLE

是否使用SSL安全连接,返回值:

  • DISABLE:不使用SSL安全连接。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全连接,并上传CA证书。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全连接AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256连接Kafka。
UserName String dtstest

源实例的数据库账号。

Status String Migrating

迁移或同步任务的状态。

迁移任务的状态,返回值为:

  • NotStarted:未启动。
  • Migrating:迁移中。
  • Failed:迁移失败。
  • Finished:迁移完成。

同步任务的状态,返回值为:

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失败。
  • Synchronizing:同步中。
  • Failed:同步失败。
  • Suspending:暂停。
  • Modifying:同步对象变更中。
  • Finished:完成。
SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

订阅Topic。

说明 当该订阅实例为新版,且调用 CreateConsumerGroup接口创建了消费组时,才会返回本参数。
SubscriptionDataType Struct

订阅数据的类型。

Ddl Boolean true

订阅数据是否包含DDL语句,返回值:

  • true:是。
  • false:否。
Dml Boolean true

订阅数据是否包含DML语句,返回值:

  • true:是。
  • false:否。
SubscriptionHost Struct

订阅任务的连接地址。

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

订阅任务的私网连接信息,格式为地址:端口号

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

订阅任务的公网连接信息,格式为地址:端口号

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

订阅任务的专有网络VPC(Virtual Private Cloud)连接信息,格式为地址:端口号

Success Boolean true

请求是否成功。

SynchronizationDirection String Forward

同步方向,返回值:

  • Forward:正向。
  • Reverse:反向。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeDtsJobDetail
&DtsJobId=ta7w132u12h****
&<公共请求参数>

正常返回示例

XML格式

<DescribeDtsJobDetailResponse>
      <DtsJobName>api测试</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格式

{
	"DtsJobName": "api测试",
	"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\"}"
}

错误码

访问错误中心查看更多错误码。