AI 助理
备案控制台
文档
输入文档关键字查找
首页 数据传输服务 开发参考 API参考 新版API（推荐） 查询DTS任务 查询DTS任务列表及各任务执行详情

查询DTS任务列表及各任务执行详情

更新时间：
产品详情
相关技术圈
我的收藏

调用DescribeDtsJobs查询DTS任务列表及各任务执行详情。

此接口对调用次数有限制，超过限制后的调用会被拒绝。

  • 单个地域累计允许调用的阈值为200次/秒。
  • 单个地域允许单个账号调用的阈值为20次/秒。

调试

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

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 DescribeDtsJobs

系统规定参数。取值：DescribeDtsJobs。
Type String 否 instance

传入本参数，指定查询条件，取值：

  • instance：根据DTS实例ID查询。
  • name：根据DTS实例名称查询，支持模糊查询。
  • srcRds：根据RDS源实例ID查询。
  • rds：根据RDS目标实例ID查询。
说明 您需要传入Params，指定查询条件的具体内容。
Params String 否 dtspk3f13r731m****

查询条件的具体内容。

说明 您需要提前传入Type，指定查询条件。
Region String 是 cn-hangzhou

DTS实例所在地域，详情请参见支持的地域列表。
Status String 否 Migrating

DTS实例状态，取值：

迁移任务状态：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Migrating：迁移中。
  • Suspending：暂停中。
  • MigrationFailed：迁移失败。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。

同步任务状态：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Initializing：同步初始化中。
  • InitializeFailed：同步初始化失败。
  • Synchronizing：同步中。
  • Failed：同步失败。
  • Suspending：暂停中。
  • Modifying：修改同步对象中。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。

订阅任务的状态：

  • NotConfigured：未配置。
  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • Starting：启动中。
  • Normal：正常。
  • Retrying：重试中。
  • Abnormal：异常。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。
OrderDirection String 否 ASC

传入本参数指定实例排序顺序，取值：

  • ASC：正序，为默认值。
  • DESC：倒序。
OrderColumn String 否 CreateTime

当返回结果包含多个DTS实例时，传入本参数指定实例的排序依据，取值：

  • CreateTime：按照实例的任务创建顺序排序。
  • FinishTime：按照实例的任务完成顺序排序。
  • duLimit（专属集群任务）：按照DTS任务使用DU的上限顺序排序，仅专属集群支持。
说明 您还可以传入OrderDirection，指定实例排序顺序为正序或倒序。
Tags String 否 [ { \"key\": \"testK\", \"value\": \"testV\" } ]

标签搜索条件，格式为JSON。

说明 标签的键和值，可通过调用ListTagResources接口查询。
PageSize Integer 否 30

每页记录数，取值：20、30、50、100，默认值为20。
PageNumber Integer 否 1

页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。
JobType String 否 MIGRATION

DTS实例的任务类型，取值：

  • MIGRATION：迁移（默认值）。
  • SYNC：同步。
  • SUBSCRIBE：订阅。
RegionId String 否 无

废弃参数。
GroupId String 否 pk13r731m****

DTS任务ID。

说明 一般情况下无需设置该参数。
DedicatedClusterId String 否 dtscluster_atyl3b5214uk***

DTS专属集群ID。
DtsJobId String 否 qa110wq5r93hb49

迁移、同步或订阅任务ID。
DtsInstanceId String 否 dtsi03e3zty16i****

迁移、同步或订阅实例ID。
ResourceGroupId String 否 rg-acfmzawhxxc****

资源组ID。
WithoutDbList Boolean 否 true

返回参数是否屏蔽任务对象（不返回DbObject参数），取值：

  • true：是，返回参数中不包含DbObject。
  • false：否，返回参数中包含DbObject，可以提升接口响应速度。
DtsBisLabel String 否 normal

DTS实例的环境标签，取值为：

  • normal：普通
  • online：线上
ZeroEtlJob Boolean 否 false

是否无感集成（Zero-ETL）任务，取值：

  • false：否。
  • true：是。
InstanceType String 否 RDS

源或目标数据库实例的类型。
InstanceId String 否 rm-bp1966yuut4w3****

请求参数InstanceType对应的源或目标数据库实例的ID。
DestProductType String 否 RDS

源数据库实例的类型。
SrcProductType String 否 RDS

目标数据库实例的类型。

返回数据

名称

类型

示例值

描述
HttpStatusCode Integer 200

状态码。
RequestId String 621BB4F8-3016-4FAA-8D5A-5D3163CC****

请求ID。
ErrCode String InternalError

调用出错时返回的错误码。
Success Boolean true

请求是否成功。
PageRecordCount Integer 20

当前页可展示的最大记录数。
TotalRecordCount Integer 15

所有符合条件的DTS实例数量。
ErrMessage String The Value of Input Parameter %s is not valid.

调用错误时返回的错误信息。
DynamicMessage String Type

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

说明 如果ErrMessage返回The Value of Input Parameter %s is not valid，且DynamicMessage返回Type，则代表所传入的请求参数Type不合法。
PageNumber Integer 2

页码。
DynamicCode String 403

动态错误码，本参数即将下线。
DtsJobList Array of DtsJobStatus

任务列表及各任务执行详情。
Status String Migrating

DTS实例状态，取值：

迁移任务状态：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Migrating：迁移中。
  • Suspending：暂停中。
  • MigrationFailed：迁移失败。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。

同步任务状态：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Initializing：同步初始化中。
  • InitializeFailed：同步初始化失败。
  • Synchronizing：同步中。
  • Failed：同步失败。
  • Suspending：暂停中。
  • Modifying：修改同步对象中。
  • ModifyFailed：修改同步对象失败。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。

订阅任务的状态：

  • NotConfigured：未配置。
  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • Starting：启动中。
  • Normal：正常。
  • Retrying：重试中。
  • Abnormal：异常。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。
OriginType String DTS任务

任务来源：

  • PTS任务
  • DMS任务
  • DTS任务
DtsJobName String RDS间迁移

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

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

说明 如查询迁移任务，该参数的单位为毫秒，如查询同步任务，该参数的单位为秒。
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].

任务失败的错误提示。
ExpireTime String 2022-03-16T08:01:19Z

实例的到期时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明 当PayType参数的返回值为PrePaid时才会返回本参数。
DtsJobId String i03e3zty16i****

迁移、同步或订阅任务ID。
CreateTime String 2021-03-16T08:01:19Z

任务创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
PayType String PrePaid

实例的付费类型，返回值：

  • PrePaid：包年包月（预付费）。
  • PostPaid：按量付费（后付费）。
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参数说明。
ConsumptionClient String 114...:dts******

下游消费客户端信息，由IP地址和DTS随机生成的随机数组成。
DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

迁移、同步或订阅对象，详细定义说明，请参见迁移、同步或订阅对象说明。
DtsJobClass String large

链路规格。

说明 关于各链路规格的说明及性能测试情况请参见数据迁移链路规格说明，数据同步链路规格说明。
ConsumptionCheckpoint String 2021-03-23T07:30:31Z

订阅实例的下游消费时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTimestamp String 2021-03-26T14:03:21Z

订阅实例中保存的数据范围的截止时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
AppName String new

是否为新版订阅，new（新版订阅）。

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

订阅实例中保存的数据范围的起始时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
DtsInstanceID String dtsi03e3zty16i****

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

同步方向，返回值：

  • Forward：正向。
  • Reverse：反向。
说明 当数据同步实例的拓扑为双向时，才会返回本参数。
Checkpoint String 1616899019

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

标签集合。
TagValue String testvalue

标签的值。
TagKey String testkey

标签的键。
DataInitializationStatus Object

全量数据迁移或初始化的状态。
Status String Finished

全量数据迁移或初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：迁移或初始化中。
  • Failed：迁移或初始化失败。
  • Finished：迁移或初始化完成。
Percent String 100

全量数据迁移或初始化进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量数据迁移或初始化失败的错误提示。
Progress String 44755

已完成全量数据迁移或初始化的记录数。
DataSynchronizationStatus Object

增量数据迁移或同步的状态。
Status String Catched

增量数据迁移或同步状态，返回值为：

  • NotStarted：未启动。
  • Migrating：迁移或同步中。
  • Failed：迁移或同步失败。
  • Finished：迁移或同步完成。
  • Catched：无延迟。
NeedUpgrade Boolean true

是否需要升级实例规格，返回值：

  • true：需要。
  • false：不需要。
说明 如需升级实例规格，请调用TransferInstanceClass进行升级。
Percent String 95

增量数据迁移或同步进度，单位为百分比。
Progress String 0/0

已完成增量数据迁移或同步的记录数。
ErrorMessage String 任务失败太久无法恢复

增量数据迁移或同步失败的错误提示。
DataEtlStatus Object

ETL任务的状态。

说明 配置ETL任务后，才会返回该参数集合。
Status String Finished

ETL任务状态，返回值为：

  • NotStarted：未启动。
  • Migrating：执行中。
  • Failed：执行失败。
  • Finished：完成。
  • Catched：无延迟。
Percent String 95

ETL任务进度，单位为百分比。
ErrorMessage String 任务失败太久无法恢复

ETL任务失败的错误提示。
Progress String 0/0

已完成ETL任务的记录数。
DestinationEndpoint Object

目标实例的连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当目标实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

目标实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

目标实例中迁移对象所属数据库的名称。
Ip String 172.16.88.***

目标实例的连接地址。
InstanceID String rm-bp1imrtn6fq7h****

目标实例ID。
Port String 3306

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

目标实例类型。
UserName String dtstest

目标实例的数据库账号。
EngineName String MySQL

目标实例的数据库类型。
MigrationMode Object

迁移类型或同步初始化类型。
DataInitialization Boolean true

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

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

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

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

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

  • true：是。
  • false：否。
FullDataCheck Boolean true

是否进行全量数据校验，返回值为：

  • true：是。
  • false：否。
IncDataCheck Boolean true

是否进行增量数据校验，返回值为：

  • true：是。
  • false：否。
Performance Object

迁移或同步链路的性能信息。
Rps String 100

每秒迁移或同步SQL语句的次数，包括BEGIN、COMMIT 、DML语句（INSERT、DELETE、UPDATE）及DDL语句。
Flow String 1

每秒迁移或同步数据的流量，单位为MB/s。
PrecheckStatus Object

预检查状态。
Status String Finished

预检查状态，返回值：

  • NotStarted：未启动。
  • Suspending：暂停中。
  • Checking：预检查中。
  • Failed：预检查失败。
  • Finished：预检查完成。
Percent String 100

预检查整体进度，单位为百分比。
ErrorMessage String CHECK__ERROR_SAME_OBJ.

预检查失败的提示信息。
Detail Array of PrecheckDetail

各预检查项的执行情况。
CheckResult String Success

检查结果，返回值：

  • Success：通过该项检查。
  • Failed：未通过该项检查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。
CheckItem String CHECK_CONN_SRC

预检查项目。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

预检查未通过时对应的修复方法。

说明 当CheckResult参数返回值为Failed时，才会返回本参数。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

预检查未通过的错误提示。

说明 当CheckResult参数返回值为Failed时，才会返回本参数。
ReverseJob Object

反向同步任务执行详情。

说明 当该任务为数据同步，且拓扑类型为双向时，才会返回该参数合集。
Status String Synchronizing

反向同步任务状态，取值：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Initializing：同步初始化中。
  • InitializeFailed：同步初始化失败。
  • Synchronizing：同步中。
  • Failed：同步失败。
  • Suspending：暂停中。
  • Modifying：修改同步对象中。
  • ModifyFailed：修改同步对象失败。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。
DtsJobName String RDS间迁移

同步任务名称。
Delay Long 0

增量数据同步的延迟时间，单位为秒。
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].

任务失败的错误提示。
DtsJobId String i03e3zty16i****

同步任务ID。
ExpireTime String 2023-03-16T08:01:19Z

实例的到期时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明 当PayType参数的返回值为PrePaid时才会返回本参数。
CreateTime String 2022-03-16T08:01:19Z

任务创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
PayType String PostPaid

实例的付费类型，返回值：

  • PrePaid：包年包月（预付费）。
  • PostPaid：按量付费（后付费）。
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参数说明。
DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

同步对象的库表结构定义，格式为JSON串，且支持一定的正则表达式。更多相关介绍和示例，请参见迁移、同步或订阅对象配置说明。
DtsJobClass String large

链路规格。

说明 关于各链路规格的说明及性能测试情况请参见数据同步链路规格说明。
DtsInstanceID String dtsi03e3zty16i****

同步实例ID。
DtsJobDirection String Reverse

同步方向，固定为Reverse（反向）。
Checkpoint String 1616980369

增量数据同步位点，格式为Unix时间戳，单位为秒。
DataInitializationStatus Object

全量数据初始化的状态。
Status String Finished

全量数据初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：初始化中。
  • Failed：初始化失败。
  • Finished：初始化完成。
Percent String 100

全量数据初始化进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量数据初始化失败的错误提示。
Progress String 43071

已完成全量数据初始化的记录数。
DataSynchronizationStatus Object

增量数据同步的状态。
Status String Migrating

增量数据同步状态。
NeedUpgrade Boolean true

是否需要升级实例规格，返回值：

  • true：需要。
  • false：不需要。
说明 如需升级实例规格，请调用TransferInstanceClass进行升级。
Percent String 100

增量数据同步进度，单位为百分比。
Progress String 20001

已完成增量数据迁移或同步的记录数。
ErrorMessage String 任务失败太久无法恢复

增量数据同步失败的错误提示。
DestinationEndpoint Object

目标实例的连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当目标实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

目标实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

目标实例中同步对象所属数据库的名称。
Ip String 172.16.88.***

目标实例的连接地址。
InstanceID String rm-bp1162kryivb8****

目标实例ID。
Port String 3306

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

目标实例类型。
UserName String dtstest

目标实例的数据库账号。
EngineName String MySQL

目标实例的数据库类型。
MigrationMode Object

同步初始化类型。
DataInitialization Boolean true

是否执行全量数据初始化，返回值：

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

是否执行增量数据同步，返回值：

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

是否执行库表结构初始化，返回值：

  • true：是。
  • false：否。
FullDataCheck Boolean true

是否进行全量数据校验，返回值为：

  • true：是。
  • false：否。
IncDataCheck Boolean true

是否进行增量数据校验，返回值为：

  • true：是。
  • false：否。
Performance Object

同步链路的性能信息。
Rps String 100

每秒同步SQL语句的次数，包括BEGIN、COMMIT 、DML语句（INSERT、DELETE、UPDATE）及DDL语句。
Flow String 1

每秒同步数据的流量，单位为MB/s。
PrecheckStatus Object

预检查状态。
Status String Finished

预检查状态，返回值：

  • NotStarted：未启动。
  • Suspending：暂停中。
  • Checking：预检查中。
  • Failed：预检查失败。
  • Finished：预检查完成。
Percent String 100

预检查整体进度，单位为百分比。
ErrorMessage String CHECK__ERROR_SAME_OBJ.

预检查失败的提示信息。
Detail Array of PrecheckDetail

各预检查项的执行情况。
CheckResult String Success

检查结果，返回值：

  • Success：通过该项检查。
  • Failed：未通过该项检查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。
CheckItem String CHECK_CONN_SRC

预检查项目。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

预检查未通过时对应的修复方法。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

预检查未通过的错误提示。
SourceEndpoint Object

源实例连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当源实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

源实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

源实例中迁移对象所属数据库的名称。
Ip String 172.16.88.***

源实例的连接地址。
InstanceID String rm-bp1imrtn6fq7h****

源实例ID。
Port String 3306

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

源实例类型。
UserName String dtstest

源实例的数据库账号。
EngineName String MySQL

源实例的数据库类型。
StructureInitializationStatus Object

库表结构初始化状态。
Status String Finished

库表结构初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：初始化中。
  • Failed：初始化失败。
  • Finished：初始化完成。
Percent String 100

库表结构初始化进度，单位为百分比。
ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

库表结构初始化失败的错误提示。
Progress String 1

已完成库表结构初始化的表的数量。
DuUsage Long 15

已使用的DTS专属集群资源，单位为Du。
CpuUsage String 90

实例的当前cpu使用率。单位：%。
MemUsage String 500

已使用的内存，单位为mb。
DedicatedClusterId String dtscluster_dpwl3**********

DTS专属集群ID。
ErrorDetails Array of ErrorDetail

报错信息。
ErrorCode String DTS-31009

错误码。
HelpUrl String https://**.ali**.com/**

帮助文档的URL。
EtlSafeCheckpoint String 1610540493

ETL任务的安全位点。
MinDu double 1

Serverless实例的DU下限。
MaxDu double 16

Serverless实例的DU上限。
FullDataCheckStatus Object

全量校验状态信息。
Status String Checking

全量校验任务的状态，返回值为：

  • NotStarted：未开始。
  • Checking：校验中。
  • Failed：校验失败。
  • Finished：校验完成。
  • Inconsistency：运行成功结果存在不一致数据。
Percent String 100

全量校验任务的进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

任务失败的错误提示。
Progress String 1 rows/s (row: 5/5, table: 1/1)

全量校验任务进展。
IncDataCheckStatus Object

增量校验状态信息。
Status String Checking

增量校验任务的状态，返回值为：

  • Catched：无延迟。
  • NotStarted：未开始。
  • Checking：校验中。
  • Failed：校验失败。
  • Inconsistency：运行成功结果存在不一致数据。
Percent String 95

增量校验任务的进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

任务失败的错误提示。
Progress String 1 rows/s (row: 5/5, table: 1/1)

增量校验任务的进展。
SourceEndpoint Object

源实例连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当源实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

源实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

源实例中迁移对象所属数据库的名称。
Ip String 172.16.88.***

源实例的连接地址。
InstanceID String rm-bp1162kryivb8****

源实例ID。
Port String 3306

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

源实例类型。
UserName String dtstest

源实例的数据库账号。
EngineName String MySQL

源实例的数据库类型。
StructureInitializationStatus Object

库表结构迁移或初始化状态。
Status String Finished

库表结构迁移或初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：迁移或初始化中。
  • Failed：迁移或初始化失败。
  • Finished：迁移或初始化完成。
Percent String 100

库表结构迁移或初始化进度，单位为百分比。
ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

库表结构迁移或初始化失败的错误提示。
Progress String 1

已完成库表结构迁移或初始化的表的数量。
RetryState Object

由于任务异常，DTS正在重试。
RetryCount Integer 5

已重试次数。
MaxRetryTime Integer 7200

最大重试时间，单位为秒。
ErrMessage String Unexpected error

重试失败的错误提示。
RetryTarget String srcDB

重试目标，返回值：

  • srcDB：源数据库。
  • destDB：目标数据库。
  • inner_module：DTS内部模块。
RetryTime Integer 3600

已重试时间，单位秒。
Module String 03

实例进展。
JobId String bi6e22ay243****

任务ID。
Retrying Boolean false

任务是否在重试中，返回值：

  • true：是。
  • false：否。
MigrationErrHelpDocId String 462133

错误码帮助文档的ID。
MigrationErrHelpDocKey String DTS-RETRY-ERR-0046

错误码帮助文档的Key。
MigrationErrCode String dts.retry.err.0046

错误码的Code。
MigrationErrType String ForeignKey

错误码的类型。
MigrationErrMsg String dts.retry.err.0046.msg

错误信息。
MigrationErrWorkaround String dts.retry.err.0046.workaround

错误解决方法。
JobType String MIGRATION

DTS任务类型，取值：

  • MIGRATION：迁移。
  • SYNC：同步。
  • SUBSCRIBE：订阅。
DuUsage Long 15

已使用的DTS专属集群资源，单位为Du。
CpuUsage String 1

实例的当前cpu使用率。单位：%。
MemUsage String 500

已使用的内存。单位：mb。
DedicatedClusterId String dtscluster_ft7y3**********

DTS专属集群ID。
ErrorDetails Array of ErrorDetail

报错信息。
ErrorCode String DTS-31009

错误码。
HelpUrl String https://**.ali**.com/**

帮助文档的URL。
DataCloudStatus Object

物理迁移上云的任务进程状态。
Status String Migrating

任务的状态，详情请参见本接口请求参数Status的描述。
NeedUpgrade Boolean false

是否需要升级实例规格，返回值：

  • true：需要。
  • false：不需要。
Percent String 85

任务进度，单位为百分比。
Progress String 1

已经完成迁移的表数量。
ErrorMessage String framework: DTS-31009: In process of processing data ****

任务失败的错误提示。
ResourceGroupId String rg-acfmzawhxxc****

资源组ID。
ResourceGroupDisplayName String default resource group

资源组名称。
MigrationErrMsg String dts.retry.err.0046.msg

错误信息。
MigrationErrHelpDocId String 462133

错误码帮助文档的ID。
MigrationErrWorkaround String dts.retry.err.0046.workaround

错误解决方法。
MigrationErrCode String dts.retry.err.0046

错误码的Code。
MigrationErrHelpDocKey String DTS-RETRY-ERR-0046

错误码帮助文档的Key。
MigrationErrType String ForeignKey

错误码的类型。
EtlSafeCheckpoint String 1610540493

ETL任务安全位点。
FullDataCheckStatus Object

全量校验状态信息。
Status String Checking

全量校验任务的状态，返回值为：

  • NotStarted：未开始。
  • Checking：校验中。
  • Failed：校验失败。
  • Finished：校验完成。
Percent String 100

全量校验任务的进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

任务失败的错误提示。
Progress String 1 rows/s (row: 5/5, table: 1/1)

全量校验任务进展。
IncDataCheckStatus Object

增量校验状态信息。
Status String Checking

增量校验任务的状态，返回值为：

  • Catched：无延迟。
  • NotStarted：未开始。
  • Checking：校验中。
  • Failed：校验失败。
Percent String 95

增量校验任务的进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

任务失败的错误提示。
Progress String 1 rows/s (row: 5/5, table: 1/1)

增量校验任务的进展。
DtsBisLabel String normal

DTS实例的环境标签，返回值为：

  • normal：普通
  • online：线上
MinDu double 1

Serverless实例的DU下限。
MaxDu double 16

Serverless实例的DU上限。
DuRealUsage String 12.0%

专属集群任务的DU使用率。
EtlDemoList Array of DtsJobStatus

任务列表及各任务执行详情。
Status String Migrating

DTS实例状态，取值：

迁移任务状态：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Migrating：迁移中。
  • Suspending：暂停中。
  • MigrationFailed：迁移失败。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。

同步任务状态：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Initializing：同步初始化中。
  • InitializeFailed：同步初始化失败。
  • Synchronizing：同步中。
  • Failed：同步失败。
  • Suspending：暂停中。
  • Modifying：修改同步对象中。
  • ModifyFailed：修改同步对象失败。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。

订阅任务的状态：

  • NotConfigured：未配置。
  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • Starting：启动中。
  • Normal：正常。
  • Retrying：重试中。
  • Abnormal：异常。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。
OriginType String DTS任务

标注任务来源：

  • PTS任务
  • DMS任务
  • DTS任务
DtsJobName String RDS间迁移

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

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

说明 如查询迁移任务，该参数的单位为毫秒，如查询同步任务，该参数的单位为秒。
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].

任务失败的错误提示。
ExpireTime String 2022-03-16T08:01:19Z

实例的到期时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明 当PayType参数的返回值为PrePaid时才会返回本参数。
DtsJobId String i03e3zty16i****

迁移、同步或订阅任务ID。
CreateTime String 2021-03-16T08:01:19Z

任务创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
PayType String PrePaid

实例的付费类型，返回值：

  • PrePaid：包年包月（预付费）。
  • PostPaid：按量付费（后付费）。
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参数说明。
ConsumptionClient String 114...:dts******

下游消费客户端信息，由IP地址和DTS随机生成的随机数组成。
DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

迁移、同步或订阅对象，详细定义说明，请参见迁移、同步或订阅对象说明。
DtsJobClass String large

链路规格。

说明 关于各链路规格的说明及性能测试情况请参见数据迁移链路规格说明，数据同步链路规格说明。
ConsumptionCheckpoint String 2021-03-23T07:30:31Z

订阅实例的下游消费时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTimestamp String 2021-03-26T14:03:21Z

订阅实例中保存的数据范围的截止时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
AppName String new

是否为新版订阅，new（新版订阅）。

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

订阅实例中保存的数据范围的起始时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
DtsInstanceID String dtsi03e3zty16i****

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

同步方向，返回值：

  • Forward：正向。
  • Reverse：反向。
说明 当数据同步实例的拓扑为双向时，才会返回本参数。
Checkpoint String 1616899019

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

标签集合。
TagValue String testvalue

标签的值。
TagKey String testkey

标签的键。
DataInitializationStatus Object

全量数据迁移或初始化的状态。
Status String Finished

全量数据迁移或初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：迁移或初始化中。
  • Failed：迁移或初始化失败。
  • Finished：迁移或初始化完成。
Percent String 100

全量数据迁移或初始化进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量数据迁移或初始化失败的错误提示。
Progress String 44755

已完成全量数据迁移或初始化的记录数。
DataSynchronizationStatus Object

增量数据迁移或同步的状态。
Status String Catched

增量数据迁移或同步状态，返回值为：

  • NotStarted：未启动。
  • Migrating：迁移或同步中。
  • Failed：迁移或同步失败。
  • Finished：迁移或同步完成。
  • Catched：无延迟。
NeedUpgrade Boolean true

是否需要升级实例规格，返回值：

  • true：需要。
  • false：不需要。
说明 如需升级实例规格，请调用TransferInstanceClass进行升级。
Percent String 95

增量数据迁移或同步进度，单位为百分比。
Progress String 0/0

已完成增量数据迁移或同步的记录数。
ErrorMessage String 任务失败太久无法恢复

增量数据迁移或同步失败的错误提示。
DataEtlStatus Object

ETL任务的状态。

说明 配置ETL任务后，才会返回该参数集合。
Status String Finished

ETL任务状态，返回值为：

  • NotStarted：未启动。
  • Migrating：执行中。
  • Failed：执行失败。
  • Finished：完成。
  • Catched：无延迟。
Percent String 95

ETL任务进度，单位为百分比。
ErrorMessage String 任务失败太久无法恢复

ETL任务失败的错误提示。
Progress String 0/0

已完成ETL任务的记录数。
DestinationEndpoint Object

目标实例的连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当目标实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

目标实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

目标实例中迁移对象所属数据库的名称。
Ip String 172.16.88.***

目标实例的连接地址。
InstanceID String rm-bp1imrtn6fq7h****

目标实例ID。
Port String 3306

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

目标实例类型。
UserName String dtstest

目标实例的数据库账号。
EngineName String MySQL

目标实例的数据库类型。
MigrationMode Object

迁移类型或同步初始化类型。
DataInitialization Boolean true

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

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

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

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

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

  • true：是。
  • false：否。
Performance Object

迁移或同步链路的性能信息。
Rps String 100

每秒迁移或同步SQL语句的次数，包括BEGIN、COMMIT 、DML语句（INSERT、DELETE、UPDATE）及DDL语句。
Flow String 1

每秒迁移或同步数据的流量，单位为MB/s。
PrecheckStatus Object

预检查状态。
Status String Finished

预检查状态，返回值：

  • NotStarted：未启动。
  • Suspending：暂停中。
  • Checking：预检查中。
  • Failed：预检查失败。
  • Finished：预检查完成。
Percent String 100

预检查整体进度，单位为百分比。
ErrorMessage String CHECK__ERROR_SAME_OBJ.

预检查失败的提示信息。
Detail Array of PrecheckDetail

各预检查项的执行情况。
CheckResult String Success

检查结果，返回值：

  • Success：通过该项检查。
  • Failed：未通过该项检查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。
CheckItem String CHECK_CONN_SRC

预检查项目。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

预检查未通过时对应的修复方法。

说明 当CheckResult参数返回值为Failed时，才会返回本参数。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

预检查未通过的错误提示。

说明 当CheckResult参数返回值为Failed时，才会返回本参数。
ReverseJob Object

反向同步任务执行详情。

说明 当该任务为数据同步，且拓扑类型为双向时，才会返回该参数合集。
Status String Synchronizing

反向同步任务状态，取值：

  • NotStarted：未启动。
  • Prechecking：预检查中。
  • PrecheckFailed：预检查失败。
  • PreCheckPass：预检查通过。
  • NotConfigured：未配置。
  • Initializing：同步初始化中。
  • InitializeFailed：同步初始化失败。
  • Synchronizing：同步中。
  • Failed：同步失败。
  • Suspending：暂停中。
  • Modifying：修改同步对象中。
  • ModifyFailed：修改同步对象失败。
  • Finished：完成。
  • Retrying：重试中。
  • Upgrade：升级中。
  • Locked：锁定中。
  • Downgrade：降级中。
DtsJobName String RDS间迁移

同步任务名称。
Delay Long 0

增量数据同步的延迟时间，单位为秒。
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].

任务失败的错误提示。
DtsJobId String i03e3zty16i****

同步任务ID。
ExpireTime String 2022-03-16T08:01:19Z

实例的到期时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明 当PayType参数的返回值为PrePaid时才会返回本参数。
CreateTime String 2021-03-16T08:01:19Z

任务创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
PayType String PostPaid

实例的付费类型，返回值：

  • PrePaid：包年包月（预付费）。
  • PostPaid：按量付费（后付费）。
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参数说明。
DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

同步对象的库表结构定义，格式为JSON串，且支持一定的正则表达式。更多相关介绍和示例，请参见迁移、同步或订阅对象配置说明。
DtsJobClass String large

链路规格。

说明 关于各链路规格的说明及性能测试情况请参见数据同步链路规格说明。
DtsInstanceID String dtsi03e3zty16i****

同步实例ID。
DtsJobDirection String Reverse

同步方向，固定为Reverse（反向）。
Checkpoint String 1616980369

增量数据同步位点，格式为Unix时间戳，单位为秒。
DataInitializationStatus Object

全量数据初始化的状态。
Status String Finished

全量数据初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：初始化中。
  • Failed：初始化失败。
  • Finished：初始化完成。
Percent String 100

全量数据初始化进度，单位为百分比。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量数据初始化失败的错误提示。
Progress String 43071

已完成全量数据初始化的记录数。
DataSynchronizationStatus Object

增量数据同步的状态。
Status String Migrating

增量数据同步状态。
NeedUpgrade Boolean true

是否需要升级实例规格，返回值：

  • true：需要。
  • false：不需要。
说明 如需升级实例规格，请调用TransferInstanceClass进行升级。
Percent String 100

增量数据同步进度，单位为百分比。
Progress String 20001

已完成增量数据迁移或同步的记录数。
ErrorMessage String 任务失败太久无法恢复

增量数据同步失败的错误提示。
DestinationEndpoint Object

目标实例的连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当目标实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

目标实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

目标实例中同步对象所属数据库的名称。
Ip String 172.16.88.***

目标实例的连接地址。
InstanceID String rm-bp1162kryivb8****

目标实例ID。
Port String 3306

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

目标实例类型。
UserName String dtstest

目标实例的数据库账号。
EngineName String MySQL

目标实例的数据库类型。
MigrationMode Object

迁移类型或同步初始化类型。
DataInitialization Boolean true

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

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

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

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

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

  • true：是。
  • false：否。
Performance Object

迁移或同步链路的性能信息。
Rps String 100

每秒迁移或同步SQL语句的次数，包括BEGIN、COMMIT 、DML语句（INSERT、DELETE、UPDATE）及DDL语句。
Flow String 1

每秒迁移或同步数据的流量，单位为MB/s。
PrecheckStatus Object

预检查状态。
Status String Finished

预检查状态，返回值：

  • NotStarted：未启动。
  • Suspending：暂停中。
  • Checking：预检查中。
  • Failed：预检查失败。
  • Finished：预检查完成。
Percent String 100

预检查整体进度，单位为百分比。
ErrorMessage String CHECK__ERROR_SAME_OBJ

预检查失败的提示信息。
Detail Array of PrecheckDetail

各预检查项的执行情况。
CheckResult String Success

检查结果，返回值：

  • Success：通过该项检查。
  • Failed：未通过该项检查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。
CheckItem String CHECK_CONN_SRC

预检查项目。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

预检查未通过时对应的修复方法。

说明 当CheckResult参数返回值为Failed时，才会返回本参数。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

预检查未通过的错误提示。

说明 当CheckResult参数返回值为Failed时，才会返回本参数。
SourceEndpoint Object

源实例连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当源实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

源实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

源实例中迁移对象所属数据库的名称。
Ip String 172.16.88.***

源实例的连接地址。
InstanceID String rm-bp1imrtn6fq7h****

源实例ID。
Port String 3306

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

源实例类型。
UserName String dtstest

源实例的数据库账号。
EngineName String MySQL

源实例的数据库类型。
StructureInitializationStatus Object

库表结构初始化状态。
Status String Finished

库表结构初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：初始化中。
  • Failed：初始化失败。
  • Finished：初始化完成。
Percent String 100

库表结构初始化进度，单位为百分比。
ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

库表结构初始化失败的错误提示。
Progress String 1

已完成库表结构初始化的表的数量。
EtlSafeCheckpoint String 1610540493

ETL任务安全位点。
SourceEndpoint Object

源实例连接信息。
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。
OracleSID String testsid

Oracle数据库的SID信息。

说明 当源实例的EngineName取值为Oracle，且Oracle数据库为非RAC实例时，才会返回本参数。
Region String cn-hangzhou

源实例所在区域，详情请参见支持的地域列表。
DatabaseName String dtstestdata

源实例中迁移对象所属数据库的名称。
Ip String 172.16.88.***

源实例的连接地址。
InstanceID String rm-bp1162kryivb8****

源实例ID。
Port String 3306

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

源实例类型。
UserName String dtstest

源实例的数据库账号。
EngineName String MySQL

源实例的数据库类型。
StructureInitializationStatus Object

库表结构迁移或初始化状态。
Status String Finished

库表结构迁移或初始化状态，取值包括：

  • NotStarted：未启动。
  • Migrating：迁移或初始化中。
  • Failed：迁移或初始化失败。
  • Finished：迁移或初始化完成。
Percent String 100

库表结构迁移或初始化进度，单位为百分比。
ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

库表结构迁移或初始化失败的错误提示。
Progress String 1

已完成库表结构迁移或初始化的表的数量。
RetryState Object

由于任务异常，DTS正在重试。
RetryCount Integer 5

已重试次数。
MaxRetryTime Integer 7200

最大重试时间，单位为秒。
ErrMessage String Unexpected error

重试失败的错误提示。
RetryTarget String srcDB

重试目标，返回值：

  • srcDB：源数据库。
  • destDB：目标数据库。
  • inner_module：DTS内部模块。
RetryTime Integer 3600

已重试时间，单位秒。
Module String 03

实例进展。
JobId String bi6e22ay243****

任务ID。
Retrying Boolean false

任务是否在重试中，返回值：

  • true：是。
  • false：否。
JobType String MIGRATION

DTS实例的任务类型，取值：

  • MIGRATION：迁移。
  • SYNC：同步。
  • SUBSCRIBE：订阅。
ResourceGroupId String rg-acfmzawhxxc****

资源组ID。
ResourceGroupDisplayName String default resource group

资源组名称。
EtlSafeCheckpoint String 1610540493

ETL任务安全位点。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeDtsJobs
&Region=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

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间迁移</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格式

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间迁移",
    "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
}

错误码

HttpCode

错误码

错误信息

描述
400 Throttling.User Request was denied due to user flow control. 由于请求频次达到阈值，请求被拒绝，请稍后重试。
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 签名已经过期，请更新签名

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

上一篇：查询一个DTS任务详情下一篇：查询DTS子任务执行状态
文档推荐