全部產品
Search
文件中心

Data Transmission Service:查詢一個DTS任務詳情

更新時間:Feb 10, 2025

調用DescribeDtsJobDetail查詢一個資料移轉、同步或訂閱任務的詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱

類型

是否必選

樣本值

描述

Action String DescribeDtsJobDetail

系統規定參數。取值:DescribeDtsJobDetail

DtsJobId String ta7w132u12h****

遷移、同步或訂閱任務ID。

DtsInstanceID String dtsta7w132u12h****

遷移、同步或訂閱執行個體ID。

SynchronizationDirection String Forward

同步方向,取值:

  • Forward:正向。
  • Reverse:反向。
說明
  • 預設取值為Forward
  • 只有當資料同步執行個體的同步拓撲為雙向同步時,本參數傳入Reverse才會生效。
RegionId String cn-hangzhou

任務所屬地區ID,請參見支援的地區列表

SyncSubJobHistory Boolean false

是否返回全部同步子任務的資訊,預設為false,只返回進行中中或者最近一次執行的同步子任務。

返回資料

名稱

類型

樣本值

描述

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

訂閱任務的Virtual Private Cloud(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

已完成增量資料移轉或同步的記錄數。

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

已完成增量資料移轉或同步的記錄數。

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

訂閱任務的Virtual Private Cloud(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執行個體的任務類型,取值:

  • MIGRATION:遷移。
  • 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

訂閱任務的Virtual Private Cloud(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執行個體的任務類型,取值:

  • MIGRATION:遷移。
  • SYNC:同步。
  • SUBSCRIBE:訂閱。
IsDemoJob Boolean false

是否子任務,傳回值:

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

任務類型。

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

已完成增量資料移轉或同步的記錄數。

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

已完成增量資料移轉或同步的記錄數。

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

訂閱任務的Virtual Private Cloud(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執行個體的任務類型,取值:

  • MIGRATION:遷移。
  • 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

訂閱任務的Virtual Private Cloud(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執行個體的任務類型,取值:

  • MIGRATION:遷移。
  • SYNC:同步。
  • SUBSCRIBE:訂閱。
IsDemoJob Boolean false

是否子任務,傳回值:

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

任務類型。

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

已完成增量資料移轉或同步的記錄數。

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的分區數。

樣本

請求樣本

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. 簽名已經到期,請更新簽名

訪問錯誤中心查看更多錯誤碼。