文档

查询一个DTS任务详情

更新时间:

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

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

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

调试

您可以在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,请参见支持的地域列表

SyncSubJobHistory Boolean false

是否返回全部同步子任务的信息,默认为false,只返回正在进行中或者最近一次执行的同步子任务。

ZeroEtlJob Boolean false

是否无感集成(Zero-ETL)任务,取值:

  • true:是。
  • false:否。
ResourceGroupId String rg-acfmzawhxxc****

资源组ID。

返回数据

名称

类型

示例值

描述

Status String Migrating

迁移或同步任务的状态。

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

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

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

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

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

FinishTime String 2023-06-16T10:34:17Z

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

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

任务失败的错误提示。

DtsJobId String i03e3zty16i****

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

CreateTime String 2022-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参数说明

DatabaseCount Integer 2

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

DtsJobClass String xlarge

链路规格。

说明 关于各链路规格的说明及性能测试情况请参见数据迁移链路规格说明数据同步链路规格说明
EndTimestamp String 2022-03-26T14:03:21Z

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

AppName String new

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

说明 该参数仅在新版订阅实例中返回。
DestNetType String VPC

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

  • CLASSIC:经典网络。
  • VPC:专有网络。
SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

订阅Topic。

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

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

RequestId String 29207299-7C41-493A-BA4F-2FAC5DE4****

请求ID。

Code Integer 200

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

Checkpoint Long 1616405159

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

Delay Long 0

增量数据迁移或者同步的延迟时间,单位为毫秒。

ExpireTime String 2023-06-16T08:01:19Z

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

说明 PayType参数的返回值为PrePaid时才会返回本参数。
ErrCode String InternalError

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

Success Boolean true

请求是否成功。

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

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

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

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

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

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

DynamicMessage String DtsJobId

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

说明 如果ErrMessage返回The Value of Input Parameter %s is not valid,且DynamicMessage返回DtsJobId,则代表所传入的请求参数DtsJobId不合法。
ConsumptionCheckpoint String 2022-03-23T07:30:31Z

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

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

ETL任务的算子信息。

说明 当任务为ETL时,才会返回本参数。
HttpStatusCode Integer 200

状态码。

BeginTimestamp String 2022-03-15T08:25:34Z

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

GroupId String rg-acfmzawhxxc****

资源组ID。

SynchronizationDirection String Forward

同步方向,取值:

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

同步方向,返回值:

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

是否子任务,返回值:

  • true:是。
  • false:否。
SourceEndpoint Object

源实例连接信息。

OracleSID String testsid

Oracle数据库的SID信息。

说明 当源实例的EngineName取值为Oracle,且Oracle数据库为非RAC实例时,才会返回本参数。
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。
Ip String 172.16.88.***

源实例的连接地址。

InstanceID String rm-bp1162kryivb8****

源实例ID。

RoleName String ram-for-dts

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

InstanceType String RDS

源实例类型。

Port String 3306

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

EngineName String MySQL

源实例的数据库类型。

Region String cn-hangzhou

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

DatabaseName String dtstestdata

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

AliyunUid String 140692647406****

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

UserName String dtstest

源实例的数据库账号。

CanModifyPassword Boolean false

是否可以修改密码,返回值为:

  • true:是。
  • false:否。
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实例时,才会返回本参数。
DatabaseName String dtstestdata

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

Region String cn-hangzhou

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

Ip String 172.16.XX.XX

目标实例的连接地址。

InstanceID String rm-bp1imrtn6fq7h****

目标实例ID。

Port String 3306

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

InstanceType String RDS

目标实例类型。

UserName String dtstest

目标实例的数据库账号。

EngineName String MySQL

目标实例的数据库类型。

CanModifyPassword Boolean false

是否可以修改密码,返回值为:

  • true:是。
  • false:否。
MigrationMode Object

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

DataExtractTransformLoad Boolean false

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

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

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

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

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

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

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

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

订阅任务的连接地址。

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

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

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

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

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

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

SubscriptionDataType Object

订阅数据的类型。

Dml Boolean true

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

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

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

  • true:是。
  • false:否。
SubDistributedJob Array of SubDistributedJob

分布式子任务的信息,如主任务不是分布式任务,此项为null。

说明 目前仅当主任务为同步任务时,才会有此字段,其他任务暂时不支持。
SubSyncJob Array of Any ****

同步子任务信息。

DtsInstanceID String dtsnjuc14kp12u****

DTS实例ID。

DtsJobId String m06j1g92124****

DTS任务ID。

DtsJobName String dtstest****

DTS实例名称。

GroupId String rg-acfmzawhxxc****

资源组ID。

DatabaseCount Integer 2

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

DtsJobClass String xlarge

链路规格。

DtsJobDirection String Forward

同步方向,返回值:

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

同步方向,取值:

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

支付类型:

  • PrePaid:预付费。
  • PostPaid:后付费。
ExpireTime String 2023-06-16T08:01:19Z

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

说明 PayType参数的返回值为PrePaid时才会返回本参数。
CreateTime String 2023-01-12T08:34:11Z

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

FinishTime String 2023-06-16T10:34:17Z

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

SourceEndpoint Object

源实例连接信息。

InstanceID String dtsnjuc14kp12u****

源实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

源实例类型。

EngineName String MySQL

源实例的数据库类型。

Ip String 192.168.XX.XX

源实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testsid

Oracle数据库的SID信息。

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

源实例的数据库账号。

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。
RoleName String ram-for-dts

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

AliyunUid String 140692647406****

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

DestinationEndpoint Object

目标实例的连接信息。

InstanceID String rm-bp1f9guj5rhzq****

目标实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

目标实例类型。

EngineName String MySQL

目标实例的数据库类型。

Ip String 192.168.XX.XX

目标实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testid

Oracle数据库的SID信息。

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

目标实例的数据库账号。

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。
RoleName String ram-for-dts

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

AliyunUid String 140692647406****

目标实例所属的阿里云账号ID。

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

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

MigrationMode Object

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

StructureInitialization Boolean true

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

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

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

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

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

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

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

  • true:是。
  • false:否。
Status String Finished

迁移或同步任务的状态。

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

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

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

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失败。
  • Synchronizing:同步中。
  • Failed:同步失败。
  • Suspending:暂停。
  • Modifying:同步对象变更中。
  • Finished:完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Delay Long 0

增量数据迁移或者同步的延迟时间,单位为毫秒。

TagList Array of TagList

标签集合。

Id Long 2

主键。

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

创建时间。

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

修改时间。

ResourceId String dtsnjuc14kp12u****

数据迁移、同步和订阅的实例ID。

ResourceType String ALIYUN::DTS::INSTANCE

资源类型。

RegionId String cn-hangzhou

任务所在区域,详情请参见支持的地域列表

AliUid Long 191448876515****

阿里云账号ID。

TagKey String key1

标签键tagkey

TagValue String value1

标签值tagvalue

TagCategory String System

标签类型,取值:

  • System:系统创建的标签。
  • Custom:用户添加的标签。
说明 当值为空时,默认返回可公示的标签。
SrcRegion String cn-hangzhou

任务所在地域。

说明 一般是指目标端地域。
Scope String 0

标签的可见性,取值:

  • 0:public
  • 1:private
Creator Long 191448876515****

标签操作者。

Checkpoint String 1616405159

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

PrecheckStatus Object

预检查状态。

Status String Finished

预检查状态,返回值为:

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Finished:完成。
Percent String 100

预检查整体进度,单位为百分比。

ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Detail Array of Detail

各预检查项的执行情况。

CheckItem String CHECK_CONN_SRC

预检查项目。

CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。

CheckResult String Success

预检查结果,返回值为:

  • Success:通过该项检查。
  • Failed:未通过该项检查。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
StructureInitializationStatus Object

库表结构初始化状态。

Status String Finished

库表结构初始化状态,取值包括:

  • NotStarted:未启动。
  • Migrating:初始化中。
  • Failed:初始化失败。
  • Finished:初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

库表结构初始化进度,单位为百分比。

Progress String 1

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataInitializationStatus Object

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

Status String Finished

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

  • NotStarted:未启动。
  • Migrating:迁移或初始化中。
  • Failed:迁移或初始化失败。
  • Finished:迁移或初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

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

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataSynchronizationStatus Object

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

Status String Catched

增量数据迁移或同步状态,返回值为:

  • NotStarted:未启动。
  • Migrating:迁移或同步中。
  • Suspending:暂停中。
  • Checking:检查中。
  • Failed:迁移或同步失败。
  • Finished:迁移或同步完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 95

增量数据迁移或同步进度。

Progress String 0.00RPS/(0.000MB/s)

每秒增量同步或迁移至目标表的数据行数和数据量。

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataEtlStatus Object

ETL任务的状态。

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

ETL任务状态,返回值为:

  • NotStarted:未启动。
  • Migrating:执行中。
  • Failed:执行失败。
  • Finished:完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

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

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

Rps String 100

每秒迁移或同步SQL语句的次数,包括BEGIN、COMMIT 、DML语句(INSERT、DELETE、UPDATE)及DDL语句。

Flow String 1

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

ReverseJob Object

反向同步任务执行详情。

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

DTS实例ID。

DtsJobId String m06j1g92124****

DTS任务ID。

DtsJobName String dtstest****

DTS实例名称。

GroupId String rg-acfmzawhxxc****

资源组ID。

DatabaseCount Integer 2

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

DtsJobClass String xlarge

链路规格。

DtsJobDirection String Forward

同步方向,返回值:

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

同步方向,取值:

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

支付类型:

  • PrePaid:预付费。
  • PostPaid:后付费。
ExpireTime String 2023-06-16T08:01:19Z

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

说明 PayType参数的返回值为PrePaid时才会返回本参数。
CreateTime String 2023-01-12T08:34:11Z

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

FinishTime String 2023-06-16T10:34:17Z

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

SourceEndpoint Object

源实例连接信息。

InstanceID String rm-bp2f3huj5rhzq****

源实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

源实例类型。

EngineName String MySQL

源实例的数据库类型。

Ip String 192.168.XX.XX

源实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testsid

Oracle数据库的SID信息。

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

源实例的数据库账号。

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。
RoleName String ram-for-dts

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

AliyunUid String 140692647406****

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

DestinationEndpoint Object

目标实例的连接信息。

InstanceID String rm-bp1f9guj5rhzq****

目标实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

目标实例类型。

EngineName String MySQL

目标实例的数据库类型。

Ip String 192.168.XX.XX

目标实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testsid

Oracle数据库的SID信息。

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

目标实例的数据库账号。

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。
RoleName String ram-for-dts

目标例所属云账号配置的角色名称。

AliyunUid String 140692647406****

目标实例所属的阿里云账号ID。

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

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

MigrationMode Object

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

StructureInitialization Boolean true

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

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

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

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

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

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

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

  • true:是。
  • false:否。
Status String Finished

迁移或同步任务的状态。

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

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

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

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失败。
  • Synchronizing:同步中。
  • Failed:同步失败。
  • Suspending:暂停。
  • Modifying:同步对象变更中。
  • Finished:完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Delay Long 0

增量数据迁移或者同步的延迟时间,单位为毫秒。

TagList Array of TagList

标签集合。

Id Long 2

主键。

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

创建时间。

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

修改时间。

ResourceId String dtsnjuc14kp12u****

数据迁移、同步和订阅的实例ID。

ResourceType String ALIYUN::DTS::INSTANCE

资源类型。

RegionId String cn-hangzhou

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

AliUid Long 191448876515****

阿里云账号ID。

TagKey String key1

标签键。

TagValue String value1

标签值。

TagCategory String System

标签类型,取值:

  • System:系统创建的标签。
  • Custom:用户添加的标签。
说明 当值为空时,默认返回可公示的标签。
SrcRegion String cn-hangzhou

任务所在地域。

说明 一般是指目标端地域。
Scope String 0

标签的可见性,取值:

  • 0:public
  • 1:private
Creator Long 191448876515****

标签操作者。

Checkpoint String 1616405159

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

PrecheckStatus Object

预检查状态。

Status String Finished

预检查状态,返回值为:

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Finished:完成。
Percent String 100

预检查整体进度,单位为百分比。

ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Detail Array of Detail

各预检查项的执行情况。

CheckItem String CHECK_CONN_SRC

预检查项目。

CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。

CheckResult String Success

检查结果,返回值:

  • Success:通过该项检查。
  • Failed:未通过该项检查。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
StructureInitializationStatus Object

库表结构初始化状态。

Status String Finished

库表结构初始化状态,取值包括:

  • NotStarted:未启动。
  • Migrating:初始化中。
  • Failed:初始化失败。
  • Finished:初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

库表结构初始化进度,单位为百分比。

Progress String 1

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataInitializationStatus Object

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

Status String Finished

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

  • NotStarted:未启动。
  • Migrating:迁移或初始化中。
  • Failed:迁移或初始化失败。
  • Finished:迁移或初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

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

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataSynchronizationStatus Object

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

Status String Catched

增量数据迁移或同步状态,返回值为:

  • NotStarted:未启动。
  • Migrating:迁移或同步中。
  • Suspending:暂停中。
  • Checking:检查中。
  • Failed:迁移或同步失败。
  • Finished:迁移或同步完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 95

增量数据迁移或同步进度。

Progress String 0.00RPS/(0.000MB/s)

每秒增量同步或迁移至目标表的数据行数和数据量。

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataEtlStatus Object

ETL任务的状态。

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

ETL任务状态,返回值为:

  • NotStarted:未启动。
  • Migrating:执行中。
  • Failed:执行失败。
  • Finished:完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

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

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

Rps String 100

每秒迁移或同步SQL语句的次数,包括BEGIN、COMMIT 、DML语句(INSERT、DELETE、UPDATE)及DDL语句。

Flow String 1

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

ReverseJob Any ****

反向同步任务执行详情。

说明 当该任务为数据同步,且拓扑类型为双向时,才会返回该参数合集。
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参数说明

SubscriptionHost Object

订阅任务的连接地址。

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

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

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

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

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

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

SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

订阅Topic。

说明 当该订阅实例为新版,且调用CreateConsumerGroup接口创建了消费组时,才会返回本参数。
ConsumptionCheckpoint String 2022-03-23T07:30:31Z

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

BeginTimestamp String 2022-03-15T08:25:34Z

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

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

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

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

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

DestNetType String VPC

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

  • CLASSIC:经典网络。
  • VPC:专有网络。
SubscriptionDataType Object

订阅数据的类型。

Ddl Boolean true

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

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

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

  • true:是。
  • false:否。
AppName String new

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

说明 该参数仅在新版订阅实例中返回。
EtlCalculator String { "cells ": [{\"shape\":\"edge\",\"attrs\":{\"line\":{\"stroke\":\"#b1b1b1\",\"strokeWidth\":1,\"targetMarker\":{\"name\":\"block\",\"args\":{\"size\":\"8\"}},\"strokeDasharray\":\"\"}},\"id\":\"cd1ec473-f9b9-4e9b-a742-ac23f442****\",\"source\":{\"cell\":\"8b261182-bfab-4803-ad8e-6bb08e3e****\",\"port\":\"out1\"},\"target\":{\"cell\":\"b36770df-f48c-4d6b-9644-54c5e924****\",\"port\":\"in1\"},\"zIndex\":7 }] }

ETL任务的算子信息。

说明 当任务为ETL时,才会返回本参数。
RetryState Object

由于任务异常,DTS正在重试。

JobId String ta7w132u12h****

任务ID。

MaxRetryTime Integer 7200

最大重试时间,单位为秒。

RetryTime Integer 3600

已重试时间,单位为秒。

RetryCount Integer 5

已重试次数。

Retrying Boolean true

是否在重试中,返回值:

  • true:是。
  • false:否。
Module String 03

实例进展。

RetryTarget String srcDB

重试目标,返回值:

  • srcDB:源数据库。
  • destDB:目标数据库。
  • inner_module:DTS内部模块。
ErrMsg String CHECK__ERROR_SAME_OBJ

报错信息。

OriginType String DTS任务

任务来源:

  • PTS任务
  • DMS任务
  • DTS任务
JobType String SYNC

DTS实例的任务类型,取值:

  • online:迁移。
  • SYNC:同步。
  • SUBSCRIBE:订阅。
IsDemoJob Boolean false

是否子任务,返回值:

  • true:是。
  • false:否。
TaskType String rds

任务类型。

MinDu double 1

DU下限。

说明 仅Serverless实例支持。
MaxDu double 16

DU上限。

说明 仅Serverless实例支持。
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参数说明

SubscriptionHost Object

订阅任务的连接地址。

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

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

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

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

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

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

SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

订阅Topic。

说明 当该订阅实例为新版,且调用CreateConsumerGroup接口创建了消费组时,才会返回本参数。
ConsumptionCheckpoint String 2022-03-23T07:30:31Z

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

BeginTimestamp String 2022-03-15T08:25:34Z

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

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

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

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

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

DestNetType String VPC

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

  • CLASSIC:经典网络。
  • VPC:专有网络。
SubscriptionDataType Object

订阅数据的类型。

Ddl Boolean true

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

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

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

  • true:是。
  • false:否。
AppName String new

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

说明 该参数仅在新版订阅实例中返回。
EtlCalculator String { "cells ": [{\"shape\":\"edge\",\"attrs\":{\"line\":{\"stroke\":\"#b1b1b1\",\"strokeWidth\":1,\"targetMarker\":{\"name\":\"block\",\"args\":{\"size\":\"8\"}},\"strokeDasharray\":\"\"}},\"id\":\"cd1ec473-f9b9-4e9b-a742-ac23f442****\",\"source\":{\"cell\":\"8b261182-bfab-4803-ad8e-6bb08e3e****\",\"port\":\"out1\"},\"target\":{\"cell\":\"b36770df-f48c-4d6b-9644-54c5e924****\",\"port\":\"in1\"},\"zIndex\":7 }] }

ETL任务的算子信息。

说明 当任务为ETL时,才会返回本参数。
RetryState Object

由于任务异常,DTS正在重试。

JobId String ta7w132u12h****

任务ID。

MaxRetryTime Integer 7200

最大重试时间,单位为秒。

RetryTime Integer 3600

已重试时间,单位为秒。

RetryCount Integer 5

已重试次数。

Retrying Boolean true

是否在重试中,返回值:

  • true:是。
  • false:否。
Module String 03

实例进展。

RetryTarget String srcDB

重试目标,返回值:

  • srcDB:源数据库。
  • destDB:目标数据库。
  • inner_module:DTS内部模块。
ErrMsg String CHECK__ERROR_SAME_OBJ

报错信息。

OriginType String DTS任务

任务来源:

  • PTS任务
  • DMS任务
  • DTS任务
JobType String SYNC

DTS实例的任务类型,取值:

  • online:迁移。
  • SYNC:同步。
  • SUBSCRIBE:订阅。
IsDemoJob Boolean false

是否子任务,返回值:

  • true:是。
  • false:否。
TaskType String rds

任务类型。

MinDu double 1

DU下限。

说明 仅Serverless实例支持。
MaxDu double 16

DU上限。

说明 仅Serverless实例支持。
SubSyncJob Array of SubSyncJob

同步子任务信息。

SubSyncJob Array of Any ****

同步子任务信息。

DtsInstanceID String dtsnjuc14kp12u****

DTS实例ID。

DtsJobId String m06j1g92124****

DTS任务ID。

DtsJobName String dtstest****

DTS实例名称。

GroupId String rg-acfmzawhxxc****

资源组ID。

DatabaseCount Integer 2

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

DtsJobClass String xlarge

链路规格。

DtsJobDirection String Forward

同步方向,返回值:

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

同步方向,取值:

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

支付类型:

  • PrePaid:预付费。
  • PostPaid:后付费。
ExpireTime String 2023-06-16T08:01:19Z

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

说明 PayType参数的返回值为PrePaid时才会返回本参数。
CreateTime String 2023-01-12T08:34:11Z

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

FinishTime String 2023-06-16T10:34:17Z

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

SourceEndpoint Object

源实例连接信息。

InstanceID String rm-bp2f3huj5rhzq****

源实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

源实例类型。

EngineName String MySQL

源实例的数据库类型。

Ip String 192.168.XX.XX

源实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testsid

Oracle数据库的SID信息。

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

源实例的数据库账号。

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。
RoleName String ram-for-dts

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

AliyunUid String 140692647406****

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

DestinationEndpoint Object

目标实例的连接信息。

InstanceID String rm-bp1f9guj5rhzq****

目标实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

目标实例类型。

EngineName String MySQL

目标实例的数据库类型。

Ip String 192.168.XX.XX

目标实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testsid

Oracle数据库的SID信息。

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

目标实例的数据库账号。

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。
RoleName String ram-for-dts

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

AliyunUid String 140692647406****

目标实例所属的阿里云账号ID。

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

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

MigrationMode Object

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

StructureInitialization Boolean true

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

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

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

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

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

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

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

  • true:是。
  • false:否。
Status String Finished

迁移或同步任务的状态。

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

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

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

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失败。
  • Synchronizing:同步中。
  • Failed:同步失败。
  • Suspending:暂停。
  • Modifying:同步对象变更中。
  • Finished:完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Delay Long 0

增量数据迁移或者同步的延迟时间,单位为毫秒。

TagList Array of TagList

标签集合。

Id Long 2

主键。

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

创建时间。

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

修改时间。

ResourceId String dtsnjuc14kp12u****

数据迁移、同步和订阅的实例ID。

ResourceType String ALIYUN::DTS::INSTANCE

资源类型。

RegionId String cn-hangzhou

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

AliUid Long 191448876515****

阿里云账号ID。

TagKey String key1

标签键。

TagValue String value1

标签值。

TagCategory String System

标签类型,取值:

  • System:系统创建的标签。
  • Custom:用户添加的标签。
说明 当值为空时,默认返回可公示的标签。
SrcRegion String cn-hangzhou

任务所在地域。

说明 一般是指目标端地域。
Scope String 0

标签的可见性,取值:

  • 0:public
  • 1:private
Creator Long 191448876515****

标签操作者。

Checkpoint String 1616405159

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

PrecheckStatus Object

预检查状态。

Status String Finished

预检查状态,返回值为:

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Finished:完成。
Percent String 100

预检查整体进度,单位为百分比。

ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Detail Array of Detail

各预检查项的执行情况。

CheckItem String CHECK_CONN_SRC

预检查项目。

CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。

CheckResult String Success

检查结果,返回值:

  • Success:通过该项检查。
  • Failed:未通过该项检查。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
StructureInitializationStatus Object

库表结构初始化状态。

Status String Finished

库表结构初始化状态,取值包括:

  • NotStarted:未启动。
  • Migrating:初始化中。
  • Failed:初始化失败。
  • Finished:初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

库表结构初始化进度,单位为百分比。

Progress String 1

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataInitializationStatus Object

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

Status String Finished

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

  • NotStarted:未启动。
  • Migrating:迁移或初始化中。
  • Failed:迁移或初始化失败。
  • Finished:迁移或初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

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

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataSynchronizationStatus Object

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

Status String Catched

增量数据迁移或同步状态,返回值为:

  • NotStarted:未启动。
  • Migrating:迁移或同步中。
  • Suspending:暂停中。
  • Checking:检查中。
  • Failed:迁移或同步失败。
  • Finished:迁移或同步完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 95

增量数据迁移或同步进度。

Progress String 0.00RPS/(0.000MB/s)

每秒增量同步或迁移至目标表的数据行数和数据量。

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataEtlStatus Object

ETL任务的状态。

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

ETL任务状态,返回值为:

  • NotStarted:未启动。
  • Migrating:执行中。
  • Failed:执行失败。
  • Finished:完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

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

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

Rps String 100

每秒迁移或同步SQL语句的次数,包括BEGIN、COMMIT 、DML语句(INSERT、DELETE、UPDATE)及DDL语句。

Flow String 1

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

ReverseJob Object

反向同步任务执行详情。

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

DTS实例ID。

DtsJobId String m06j1g92124****

DTS任务ID。

DtsJobName String dtstest****

DTS实例名称。

GroupId String rg-acfmzawhxxc****

资源组ID。

DatabaseCount Integer 2

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

DtsJobClass String xlarge

链路规格。

DtsJobDirection String Forward

同步方向,返回值:

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

同步方向,取值:

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

支付类型:

  • PrePaid:预付费。
  • PostPaid:后付费。
ExpireTime String 2023-06-16T08:01:19Z

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

说明 PayType参数的返回值为PrePaid时才会返回本参数。
CreateTime String 2023-01-12T08:34:11Z

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

FinishTime String 2023-06-16T10:34:17Z

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

SourceEndpoint Object

源实例连接信息。

InstanceID String rm-bp2f3huj5rhzq****

实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

源实例类型。

EngineName String MySQL

源实例的数据库类型。

Ip String 192.168.XX.XX

源实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testsid

Oracle数据库的SID信息。

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

源实例的数据库账号。

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。
RoleName String ram-for-dts

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

AliyunUid String 140692647406****

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

DestinationEndpoint Object

目标实例的连接信息。

InstanceID String rm-bp1f9guj5rhzq****

目标实例ID。

Region String cn-hangzhou

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

InstanceType String RDS

目标实例类型。

EngineName String MySQL

目标实例的数据库类型。

Ip String 192.168.XX,XX

目标实例的连接地址。

Port String 3306

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

DatabaseName String dtstestdata

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

OracleSID String testsid

Oracle数据库的SID信息。

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

目标实例的数据库账号。

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。
RoleName String ram-for-dts

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

AliyunUid String 140692647406****

目标实例所属的阿里云账号ID。

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

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

MigrationMode Object

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

StructureInitialization Boolean true

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

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

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

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

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

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

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

  • true:是。
  • false:否。
Status String Finished

迁移或同步任务的状态。

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

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

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

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失败。
  • Synchronizing:同步中。
  • Failed:同步失败。
  • Suspending:暂停。
  • Modifying:同步对象变更中。
  • Finished:完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Delay Long 0

增量数据迁移或者同步的延迟时间,单位为毫秒。

TagList Array of TagList

标签集合。

Id Long 2

主键。

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

创建时间。

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

修改时间。

ResourceId String dtsnjuc14kp12u****

数据迁移、同步和订阅的实例ID。

ResourceType String ALIYUN::DTS::INSTANCE

资源类型。

RegionId String cn-hangzhou

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

AliUid Long 191448876515****

阿里云账号ID。

TagKey String key1

标签键。

TagValue String value1

标签值。

TagCategory String System

标签类型,取值:

  • System:系统创建的标签。
  • Custom:用户添加的标签。
说明 当值为空时,默认返回可公示的标签。
SrcRegion String cn-hangzhou

任务所在地域。

说明 一般是指目标端地域。
Scope String 0

标签的可见性,取值:

  • 0:public
  • 1:private
Creator Long 191448876515****

标签操作者。

Checkpoint String 1616405159

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

PrecheckStatus Object

预检查状态。

Status String Finished

预检查状态,返回值为:

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Finished:完成。
Percent String 100

预检查整体进度,单位为百分比。

ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Detail Array of Detail

各预检查项的执行情况。

CheckItem String CHECK_CONN_SRC

预检查项目。

CheckItemDescription String CHECK_CONN_SRC_DETAIL

预检查项目描述。

CheckResult String Success

检查结果,返回值:

  • Success:通过该项检查。
  • Failed:未通过该项检查。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

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

说明 CheckResult参数返回值为Failed时,才会返回本参数。
StructureInitializationStatus Object

库表结构初始化状态。

Status String Finished

库表结构初始化状态,取值包括:

  • NotStarted:未启动。
  • Migrating:初始化中。
  • Failed:初始化失败。
  • Finished:初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

库表结构初始化进度,单位为百分比。

Progress String 1

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataInitializationStatus Object

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

Status String Finished

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

  • NotStarted:未启动。
  • Migrating:迁移或初始化中。
  • Failed:迁移或初始化失败。
  • Finished:迁移或初始化完成。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

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

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataSynchronizationStatus Object

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

Status String Finished

增量数据迁移或同步状态,返回值为:

  • NotStarted:未启动。
  • Migrating:迁移或同步中。
  • Suspending:暂停中。
  • Checking:检查中。
  • Failed:迁移或同步失败。
  • Finished:迁移或同步完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 95

增量数据迁移或同步进度。

Progress String 0.00RPS/(0.000MB/s)

每秒增量同步或迁移至目标表的数据行数和数据量。

NeedUpgrade Boolean true

是否显示提升升级规格,返回值:

  • true:是。
  • false:否。
DataEtlStatus Object

ETL任务的状态。

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

ETL任务状态,返回值为:

  • NotStarted:未启动。
  • Migrating:执行中。
  • Failed:执行失败。
  • Finished:完成。
  • Catched:无延迟。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by ****

任务失败的错误提示。

Percent String 100

全量数据迁移或初始化进度,单位为百分比。

Progress String 16

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

NeedUpgrade Boolean true

是否显示升级实例规格,返回值:

  • true:需要。
  • false:不需要。
Performance Object

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

Rps String 100

每秒迁移或同步SQL语句的次数,包括BEGIN、COMMIT 、DML语句(INSERT、DELETE、UPDATE)及DDL语句。

Flow String 1

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

ReverseJob Any ****

反向同步任务执行详情。

说明 当该任务为数据同步,且拓扑类型为双向时,才会返回该参数合集。
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参数说明

SubscriptionHost Object

订阅任务的连接地址。

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

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

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

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

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

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

SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

订阅Topic。

说明 当该订阅实例为新版,且调用CreateConsumerGroup接口创建了消费组时,才会返回本参数。
ConsumptionCheckpoint String 2022-03-23T07:30:31Z

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

BeginTimestamp String 2022-03-15T08:25:34Z

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

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

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

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

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

DestNetType String VPC

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

  • CLASSIC:经典网络。
  • VPC:专有网络。
SubscriptionDataType Object

订阅数据的类型。

Ddl Boolean true

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

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

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

  • true:是。
  • false:否。
AppName String new

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

说明 该参数仅在新版订阅实例中返回。
EtlCalculator String { "cells ": [{\"shape\":\"edge\",\"attrs\":{\"line\":{\"stroke\":\"#b1b1b1\",\"strokeWidth\":1,\"targetMarker\":{\"name\":\"block\",\"args\":{\"size\":\"8\"}},\"strokeDasharray\":\"\"}},\"id\":\"cd1ec473-f9b9-4e9b-a742-ac23f442****\",\"source\":{\"cell\":\"8b261182-bfab-4803-ad8e-6bb08e3e****\",\"port\":\"out1\"},\"target\":{\"cell\":\"b36770df-f48c-4d6b-9644-54c5e924****\",\"port\":\"in1\"},\"zIndex\":7 }] }

ETL任务的算子信息。

说明 当任务为ETL时,才会返回本参数。
RetryState Object

由于任务异常,DTS正在重试。

JobId String ta7w132u12h****

任务ID。

MaxRetryTime Integer 7200

最大重试时间,单位为秒。

RetryTime Integer 3600

已重试时间,单位为秒。

RetryCount Integer 5

已重试次数。

Retrying Boolean true

是否在重试中,返回值:

  • true:是。
  • false:否。
Module String 03

实例进展。

RetryTarget String srcDB

重试目标,返回值:

  • srcDB:源数据库。
  • destDB:目标数据库。
  • inner_module:DTS内部模块。
ErrMsg String CHECK__ERROR_SAME_OBJ

报错信息。

OriginType String DTS任务

任务来源:

  • PTS任务
  • DMS任务
  • DTS任务
JobType String SYNC

DTS实例的任务类型,取值:

  • online:迁移。
  • SYNC:同步。
  • SUBSCRIBE:订阅。
IsDemoJob Boolean false

是否子任务,返回值:

  • true:是。
  • false:否。
TaskType String rds

任务类型。

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参数说明

SubscriptionHost Object

订阅任务的连接地址。

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

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

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

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

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

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

SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

订阅Topic。

说明 当该订阅实例为新版,且调用CreateConsumerGroup接口创建了消费组时,才会返回本参数。
ConsumptionCheckpoint String 2022-03-23T07:30:31Z

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

BeginTimestamp String 2022-03-15T08:25:34Z

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

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

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

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

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

DestNetType String VPC

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

  • CLASSIC:经典网络。
  • VPC:专有网络。
SubscriptionDataType Object

订阅数据的类型。

Ddl Boolean true

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

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

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

  • true:是。
  • false:否。
AppName String new

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

说明 该参数仅在新版订阅实例中返回。
EtlCalculator String { "cells ": [{\"shape\":\"edge\",\"attrs\":{\"line\":{\"stroke\":\"#b1b1b1\",\"strokeWidth\":1,\"targetMarker\":{\"name\":\"block\",\"args\":{\"size\":\"8\"}},\"strokeDasharray\":\"\"}},\"id\":\"cd1ec473-f9b9-4e9b-a742-ac23f442****\",\"source\":{\"cell\":\"8b261182-bfab-4803-ad8e-6bb08e3e****\",\"port\":\"out1\"},\"target\":{\"cell\":\"b36770df-f48c-4d6b-9644-54c5e924****\",\"port\":\"in1\"},\"zIndex\":7 }] }

ETL任务的算子信息。

说明 当任务为ETL时,才会返回本参数。
RetryState Object

由于任务异常,DTS正在重试。

JobId String ta7w132u12h****

任务ID。

MaxRetryTime Integer 7200

最大重试时间,单位为秒。

RetryTime Integer 3600

已重试时间,单位为秒。

RetryCount Integer 5

已重试次数。

Retrying Boolean true

是否在重试中,返回值:

  • true:是。
  • false:否。
Module String 03

实例进展。

RetryTarget String srcDB

重试目标,返回值:

  • srcDB:源数据库。
  • destDB:目标数据库。
  • inner_module:DTS内部模块。
ErrMsg String CHECK__ERROR_SAME_OBJ

报错信息。

OriginType String DTS任务

任务来源:

  • PTS任务
  • DMS任务
  • DTS任务
JobType String SYNC

DTS实例的任务类型,取值:

  • online:迁移。
  • SYNC:同步。
  • SUBSCRIBE:订阅。
IsDemoJob Boolean false

是否子任务,返回值:

  • true:是。
  • false:否。
TaskType String rds

任务类型。

MinDu double 1

DU下限。

说明 仅Serverless实例支持。
MaxDu double 16

DU上限。

说明 仅Serverless实例支持。
JobType String sync

指示任务的类型,取值:

  • sync:同步任务。
  • subSync:修改同步对象产生的子任务。
说明 一般与TaskType搭配使用。
TaskType String Distributed_xxx

指示任务的业务类型。

说明 一般与JobType搭配使用。
DedicatedClusterId String dtsxxxxx

专属集群ID。

DataSynchronizationStatus Object

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

Status String Catched

增量数据迁移或同步状态,返回值为:

  • NotStarted:未启动。
  • Migrating:迁移或同步中。
  • Suspending:暂停中。
  • Checking:检查中。
  • Failed:迁移或同步失败。
  • Finished:迁移或同步完成。
  • Catched:无延迟。
NeedUpgrade Boolean true

是否显示升级实例规格,返回值:

  • true:需要。
  • false:不需要。
Percent String 95

增量数据迁移或同步进度,单位为百分比。

Progress String 0.00RPS/(0.000MB/s)

每秒增量同步或迁移至目标表的数据行数和数据量。

ErrorMessage String 任务失败太久无法恢复

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

BootTime String 2022-03-30T03:36:11.000

具体项目启动时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Binlog String ****

Binlog信息。

BinlogSite String 156629109****

当前位点。

BinlogTime String ****

位点范围。

LastUpdateTime String 156629109****

最后一次更新的时间戳。

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:否。
ResourceGroupId String rg-acfmzawhxxc****

资源组ID。

ResourceGroupDisplayName String default resource group

资源组名称。

DtsBisLabel String normal

DTS实例的环境标签,返回值为:

  • normal普通
  • online线上
DataDeliveryChannelInfo Object

数据投递通道信息。

PublicDproxyUrl String dts-****.aliyuncs.com:18***

投递通道的公网地址。

VpcDproxyUrl String dts-****.aliyuncs.com:18***

投递通道的VPC网络地址。

Topic String cn_hangzhou_******_data_delivery_version2

投递的目标Topic。

Region String cn-hangzhou

投递通道所在区域。

PartitionNum Integer 3

投递Topic的分片数。

MinDu double 1

DU下限。

说明 仅Serverless实例支持。
MaxDu double 16

DU上限。

说明 仅Serverless实例支持。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/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/>
        <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格式

HTTP/1.1 200 OK
Content-Type:application/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\"}"
}

错误码

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. 签名已经过期,请更新签名

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