全部產品
Search
文件中心

Data Transmission Service:查詢DTS工作清單及各任務執行詳情

更新時間:Feb 10, 2025

調用DescribeDtsJobs查詢DTS工作清單及各任務執行詳情。

此介面對調用次數有限制,超過限制後的調用會被拒絕。

  • 單個地區累計允許調用的閾值為200次/秒。
  • 單個地區允許單個帳號調用的閾值為20次/秒。

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String DescribeDtsJobs

系統規定參數。取值:DescribeDtsJobs

Type String instance

傳入本參數,指定查詢條件,取值:

  • instance:根據DTS執行個體ID查詢。
  • name:根據DTS執行個體名稱查詢,支援模糊查詢。
  • srcRds:根據RDS源執行個體ID查詢。
  • rds:根據RDS目標執行個體ID查詢。
說明 您需要傳入Params,指定查詢條件的具體內容。
Params String dtspk3f13r731m****

查詢條件的具體內容。

說明 您需要提前傳入Type,指定查詢條件。
Region String cn-hangzhou

DTS執行個體所在地區,詳情請參見支援的地區列表

Status String Migrating

DTS執行個體狀態,取值:

遷移任務狀態:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Migrating:遷移中。
  • Suspending:暫停中。
  • MigrationFailed:遷移失敗。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。

同步任務狀態:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失敗。
  • Synchronizing:同步中。
  • Failed:同步失敗。
  • Suspending:暫停中。
  • Modifying:修改同步對象中。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。

訂閱任務的狀態:

  • NotConfigured:未配置。
  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • Starting:啟動中。
  • Normal:正常。
  • Retrying:重試中。
  • Abnormal:異常。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。
OrderDirection String ASC

傳入本參數指定執行個體排序次序,取值:

  • ASC:正序,為預設值。
  • DESC:倒序。
OrderColumn String CreateTime

當返回結果包含多個DTS執行個體時,傳入本參數指定執行個體的排序依據,取值:

  • CreateTime:按照執行個體的任務建立順序排序。
  • FinishTime:按照執行個體的任務完成順序排序。
  • duLimit(專屬叢集任務):按照DTS任務使用DU的上限順序排序,僅專屬叢集支援。
說明 您還可以傳入OrderDirection,指定執行個體排序次序為正序或倒序。
Tags String [ { \"key\": \"testK\", \"value\": \"testV\" } ]

標籤搜尋條件,格式為JSON。

說明 標籤的鍵和值,可通過調用ListTagResources介面查詢。
PageSize Integer 30

每頁記錄數,取值:203050100,預設值為20

PageNumber Integer 1

頁碼,取值為大於0且不超過Integer資料類型的最大值,預設值為1

JobType String MIGRATION

DTS執行個體的任務類型,取值:

  • MIGRATION:遷移(預設值)。
  • SYNC:同步。
  • SUBSCRIBE:訂閱。
RegionId String

廢棄參數。

GroupId String pk13r731m****

DTS任務ID。

說明 一般情況下無需設定該參數。
DedicatedClusterId String dtscluster_atyl3b5214uk***

DTS專屬叢集ID。

DtsJobId String qa110wq5r93hb49

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

DtsInstanceId String dtsi03e3zty16i****

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

ResourceGroupId String rg-acfmzawhxxc****

資源群組ID。

WithoutDbList Boolean true

返回參數是否屏蔽任務對象(不返回DbObject參數),取值:

  • true:是,返回參數中不包含DbObject
  • false:否,返回參數中包含DbObject,可以提升介面響應速度。
DtsBisLabel String normal

DTS執行個體的環境標籤,取值為:

  • normal普通
  • online線上
ZeroEtlJob Boolean false

是否無感整合(Zero-ETL)任務,取值:

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

源或目標資料庫執行個體的類型。

InstanceId String rm-bp1966yuut4w3****

請求參數InstanceType對應的源或目標資料庫執行個體的ID。

DestProductType String RDS

來源資料庫執行個體的類型。

SrcProductType String RDS

目標資料庫執行個體的類型。

返回資料

名稱

類型

樣本值

描述

HttpStatusCode Integer 200

狀態代碼。

RequestId String 621BB4F8-3016-4FAA-8D5A-5D3163CC****

請求ID。

ErrCode String InternalError

調用出錯時返回的錯誤碼。

Success Boolean true

請求是否成功。

PageRecordCount Integer 20

當前頁可展示的最大記錄數。

TotalRecordCount Integer 15

所有合格DTS執行個體數量。

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

調用錯誤時返回的錯誤資訊。

DynamicMessage String Type

動態錯誤資訊,用於替換返回參數ErrMessage錯誤資訊中的%s

說明 如果ErrMessage返回The Value of Input Parameter %s is not valid,且DynamicMessage返回Type,則代表所傳入的請求參數Type不合法。
PageNumber Integer 2

頁碼。

DynamicCode String 403

動態錯誤碼,本參數即將下線。

DtsJobList Array of DtsJobStatus

工作清單及各任務執行詳情。

Status String Migrating

DTS執行個體狀態,取值:

遷移任務狀態:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Migrating:遷移中。
  • Suspending:暫停中。
  • MigrationFailed:遷移失敗。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。

同步任務狀態:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失敗。
  • Synchronizing:同步中。
  • Failed:同步失敗。
  • Suspending:暫停中。
  • Modifying:修改同步對象中。
  • ModifyFailed:修改同步對象失敗。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。

訂閱任務的狀態:

  • NotConfigured:未配置。
  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • Starting:啟動中。
  • Normal:正常。
  • Retrying:重試中。
  • Abnormal:異常。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。
OriginType String DTS任務

任務來源:

  • PTS任務
  • DMS任務
  • DTS任務
DtsJobName String RDS間遷移

遷移、同步或訂閱任務名稱。

Delay Long 0

增量資料移轉或者同步的延遲時間。

說明 如查詢遷移任務,該參數的單位為毫秒,如查詢同步任務,該參數的單位為秒。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].

任務失敗的錯誤提示。

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

執行個體的到期時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

說明 PayType參數的傳回值為PrePaid時才會返回本參數。
DtsJobId String i03e3zty16i****

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

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

任務建立時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

PayType String PrePaid

執行個體的付費類型,傳回值:

  • PrePaid:訂用帳戶(預付費)。
  • PostPaid:隨用隨付(後付費)。
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

DTS預留參數,格式為JSON串,您可以傳入本參數實現特殊需求(例如是否自動啟動預檢查)。更多資訊,請參見MigrationReserved參數說明

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

下遊消費用戶端資訊,由IP地址和DTS隨機產生的隨機數組成。

DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

遷移、同步或訂閱對象,詳細定義說明,請參見遷移、同步或訂閱對象說明

DtsJobClass String large

鏈路規格。

說明 關於各鏈路規格的說明及效能測試情況請參見資料移轉鏈路規格說明資料同步鏈路規格說明
ConsumptionCheckpoint String 2021-03-23T07:30:31Z

訂閱執行個體的下遊消費時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

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

訂閱執行個體中儲存的資料範圍的截止時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

AppName String new

是否為新版訂閱,new(新版訂閱)。

說明 該參數僅在新版訂閱執行個體中返回。
BeginTimestamp String 2021-03-15T08:25:34Z

訂閱執行個體中儲存的資料範圍的起始時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

DtsInstanceID String dtsi03e3zty16i****

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

DtsJobDirection String Forward

同步方向,傳回值:

  • Forward:正向。
  • Reverse:反向。
說明 當資料同步執行個體的拓撲為雙向時,才會返回本參數。
Checkpoint String 1616899019

增量資料移轉的啟動位點或者同步位點,格式為Unix時間戳記,單位為秒。

TagList Array of DtsTag

標籤集合。

TagValue String testvalue

標籤的值。

TagKey String testkey

標籤的鍵。

DataInitializationStatus Object

全量資料移轉或初始化的狀態。

Status String Finished

全量資料移轉或初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:遷移或初始化中。
  • Failed:遷移或初始化失敗。
  • Finished:遷移或初始化完成。
Percent String 100

全量資料移轉或初始化進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量資料移轉或初始化失敗的錯誤提示。

Progress String 44755

已完成全量資料移轉或初始化的記錄數。

DataSynchronizationStatus Object

增量資料移轉或同步的狀態。

Status String Catched

增量資料移轉或同步狀態,傳回值為:

  • NotStarted:未啟動。
  • Migrating:遷移或同步中。
  • Failed:遷移或同步失敗。
  • Finished:遷移或同步完成。
  • Catched:無延遲。
NeedUpgrade Boolean true

是否需要升級執行個體規格,傳回值:

  • true:需要。
  • false:不需要。
說明 如需升級執行個體規格,請調用TransferInstanceClass進行升級。
Percent String 95

增量資料移轉或同步進度,單位為百分比。

Progress String 0/0

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

ErrorMessage String 任務失敗太久無法恢複

增量資料移轉或同步失敗的錯誤提示。

DataEtlStatus Object

ETL任務的狀態。

說明 配置ETL任務後,才會返回該參數集合。
Status String Finished

ETL任務狀態,傳回值為:

  • NotStarted:未啟動。
  • Migrating:執行中。
  • Failed:執行失敗。
  • Finished:完成。
  • Catched:無延遲。
Percent String 95

ETL任務進度,單位為百分比。

ErrorMessage String 任務失敗太久無法恢複

ETL任務失敗的錯誤提示。

Progress String 0/0

已完成ETL任務的記錄數。

DestinationEndpoint Object

目標執行個體的串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當目標執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

目標執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

目標執行個體中遷移對象所屬資料庫的名稱。

Ip String 172.16.88.***

目標執行個體的串連地址。

InstanceID String rm-bp1imrtn6fq7h****

目標執行個體ID。

Port String 3306

目標執行個體的資料庫服務連接埠。

InstanceType String RDS

目標執行個體類型。

UserName String dtstest

目標執行個體的資料庫帳號。

EngineName String MySQL

目標執行個體的資料庫類型。

MigrationMode Object

遷移類型或同步初始化類型。

DataInitialization Boolean true

是否執行全量資料移轉或全量資料初始化,傳回值:

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

是否執行增量資料移轉或同步,傳回值:

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

是否執行庫表結構遷移或初始化,傳回值:

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

是否進行全量資料校正,傳回值為:

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

是否進行增量資料校正,傳回值為:

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

遷移或同步鏈路的效能資訊。

Rps String 100

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

Flow String 1

每秒遷移或同步資料的流量,單位為MB/s。

PrecheckStatus Object

預檢查狀態。

Status String Finished

預檢查狀態,傳回值:

  • NotStarted:未啟動。
  • Suspending:暫停中。
  • Checking:預檢查中。
  • Failed:預檢查失敗。
  • Finished:預檢查完成。
Percent String 100

預檢查整體進度,單位為百分比。

ErrorMessage String CHECK__ERROR_SAME_OBJ.

預檢查失敗的提示資訊。

Detail Array of PrecheckDetail

各預檢查項的執行情況。

CheckResult String Success

檢查結果,傳回值:

  • Success:通過該項檢查。
  • Failed:未通過該項檢查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

預檢查專案描述。

CheckItem String CHECK_CONN_SRC

預檢查專案。

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

預檢查未通過時對應的修複方法。

說明 CheckResult參數傳回值為Failed時,才會返回本參數。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

預檢查未通過的錯誤提示。

說明 CheckResult參數傳回值為Failed時,才會返回本參數。
ReverseJob Object

反向同步任務執行詳情。

說明 當該任務為資料同步,且拓撲類型為雙向時,才會返回該參數合集。
Status String Synchronizing

反向同步任務狀態,取值:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失敗。
  • Synchronizing:同步中。
  • Failed:同步失敗。
  • Suspending:暫停中。
  • Modifying:修改同步對象中。
  • ModifyFailed:修改同步對象失敗。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。
DtsJobName String RDS間遷移

同步任務名稱。

Delay Long 0

增量資料同步的延遲時間,單位為秒。

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

任務失敗的錯誤提示。

DtsJobId String i03e3zty16i****

同步任務ID。

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

執行個體的到期時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

說明 PayType參數的傳回值為PrePaid時才會返回本參數。
CreateTime String 2022-03-16T08:01:19Z

任務建立時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

PayType String PostPaid

執行個體的付費類型,傳回值:

  • PrePaid:訂用帳戶(預付費)。
  • PostPaid:隨用隨付(後付費)。
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

DTS預留參數,格式為JSON串,您可以傳入本參數實現特殊需求(例如是否自動啟動預檢查)。更多資訊,請參見MigrationReserved參數說明

DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

同步對象的庫表結構定義,格式為JSON串,且支援一定的Regex。更多相關介紹和樣本,請參見遷移、同步或訂閱對象配置說明。

DtsJobClass String large

鏈路規格。

說明 關於各鏈路規格的說明及效能測試情況請參見資料同步鏈路規格說明
DtsInstanceID String dtsi03e3zty16i****

同步執行個體ID。

DtsJobDirection String Reverse

同步方向,固定為Reverse(反向)。

Checkpoint String 1616980369

增量資料同步位點,格式為Unix時間戳記,單位為秒。

DataInitializationStatus Object

全量資料初始化的狀態。

Status String Finished

全量資料初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:初始化中。
  • Failed:初始化失敗。
  • Finished:初始化完成。
Percent String 100

全量資料初始化進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量資料初始化失敗的錯誤提示。

Progress String 43071

已完成全量資料初始化的記錄數。

DataSynchronizationStatus Object

增量資料同步的狀態。

Status String Migrating

增量資料同步狀態。

NeedUpgrade Boolean true

是否需要升級執行個體規格,傳回值:

  • true:需要。
  • false:不需要。
說明 如需升級執行個體規格,請調用TransferInstanceClass進行升級。
Percent String 100

增量資料同步進度,單位為百分比。

Progress String 20001

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

ErrorMessage String 任務失敗太久無法恢複

增量資料同步失敗的錯誤提示。

DestinationEndpoint Object

目標執行個體的串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當目標執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

目標執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

目標執行個體中同步對象所屬資料庫的名稱。

Ip String 172.16.88.***

目標執行個體的串連地址。

InstanceID String rm-bp1162kryivb8****

目標執行個體ID。

Port String 3306

目標執行個體的資料庫服務連接埠。

InstanceType String RDS

目標執行個體類型。

UserName String dtstest

目標執行個體的資料庫帳號。

EngineName String MySQL

目標執行個體的資料庫類型。

MigrationMode Object

同步初始化類型。

DataInitialization Boolean true

是否執行全量資料初始化,傳回值:

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

是否執行增量資料同步,傳回值:

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

是否執行庫表結構初始化,傳回值:

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

是否進行全量資料校正,傳回值為:

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

是否進行增量資料校正,傳回值為:

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

同步鏈路的效能資訊。

Rps String 100

每秒同步SQL語句的次數,包括BEGIN、COMMIT 、DML語句(INSERT、DELETE、UPDATE)及DDL語句。

Flow String 1

每秒同步資料的流量,單位為MB/s。

PrecheckStatus Object

預檢查狀態。

Status String Finished

預檢查狀態,傳回值:

  • NotStarted:未啟動。
  • Suspending:暫停中。
  • Checking:預檢查中。
  • Failed:預檢查失敗。
  • Finished:預檢查完成。
Percent String 100

預檢查整體進度,單位為百分比。

ErrorMessage String CHECK__ERROR_SAME_OBJ.

預檢查失敗的提示資訊。

Detail Array of PrecheckDetail

各預檢查項的執行情況。

CheckResult String Success

檢查結果,傳回值:

  • Success:通過該項檢查。
  • Failed:未通過該項檢查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

預檢查專案描述。

CheckItem String CHECK_CONN_SRC

預檢查專案。

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

預檢查未通過時對應的修複方法。

FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

預檢查未通過的錯誤提示。

SourceEndpoint Object

源執行個體串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當源執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

源執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

源執行個體中遷移對象所屬資料庫的名稱。

Ip String 172.16.88.***

源執行個體的串連地址。

InstanceID String rm-bp1imrtn6fq7h****

源執行個體ID。

Port String 3306

源執行個體的資料庫服務連接埠。

InstanceType String RDS

源執行個體類型。

UserName String dtstest

源執行個體的資料庫帳號。

EngineName String MySQL

源執行個體的資料庫類型。

StructureInitializationStatus Object

庫表結構初始化狀態。

Status String Finished

庫表結構初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:初始化中。
  • Failed:初始化失敗。
  • Finished:初始化完成。
Percent String 100

庫表結構初始化進度,單位為百分比。

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

庫表結構初始化失敗的錯誤提示。

Progress String 1

已完成庫表結構初始化的表的數量。

DuUsage Long 15

已使用的DTS專屬叢集資源,單位為Du。

CpuUsage String 90

執行個體的當前cpu使用率。單位:%。

MemUsage String 500

已使用的記憶體,單位為mb。

DedicatedClusterId String dtscluster_dpwl3**********

DTS專屬叢集ID。

ErrorDetails Array of ErrorDetail

報錯資訊。

ErrorCode String DTS-31009

錯誤碼。

HelpUrl String https://**.ali**.com/**

協助文檔的URL。

EtlSafeCheckpoint String 1610540493

ETL任務的安全位元點。

MinDu double 1

Serverless執行個體的DU下限。

MaxDu double 16

Serverless執行個體的DU上限。

FullDataCheckStatus Object

全量校正狀態資訊。

Status String Checking

全量校正任務的狀態,傳回值為:

  • NotStarted:未開始。
  • Checking:校正中。
  • Failed:校正失敗。
  • Finished:校正完成。
  • Inconsistency:運行成功結果存在不一致資料。
Percent String 100

全量校正任務的進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

任務失敗的錯誤提示。

Progress String 1 rows/s (row: 5/5, table: 1/1)

全量校正任務進展。

IncDataCheckStatus Object

增量校正狀態資訊。

Status String Checking

增量校正任務的狀態,傳回值為:

  • Catched:無延遲。
  • NotStarted:未開始。
  • Checking:校正中。
  • Failed:校正失敗。
  • Inconsistency:運行成功結果存在不一致資料。
Percent String 95

增量校正任務的進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

任務失敗的錯誤提示。

Progress String 1 rows/s (row: 5/5, table: 1/1)

增量校正任務的進展。

SourceEndpoint Object

源執行個體串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當源執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

源執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

源執行個體中遷移對象所屬資料庫的名稱。

Ip String 172.16.88.***

源執行個體的串連地址。

InstanceID String rm-bp1162kryivb8****

源執行個體ID。

Port String 3306

源執行個體的資料庫服務連接埠。

InstanceType String RDS

源執行個體類型。

UserName String dtstest

源執行個體的資料庫帳號。

EngineName String MySQL

源執行個體的資料庫類型。

StructureInitializationStatus Object

庫表結構遷移或初始化狀態。

Status String Finished

庫表結構遷移或初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:遷移或初始化中。
  • Failed:遷移或初始化失敗。
  • Finished:遷移或初始化完成。
Percent String 100

庫表結構遷移或初始化進度,單位為百分比。

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

庫表結構遷移或初始化失敗的錯誤提示。

Progress String 1

已完成庫表結構遷移或初始化的表的數量。

RetryState Object

由於任務異常,DTS正在重試。

RetryCount Integer 5

已重試次數。

MaxRetryTime Integer 7200

最大重試時間,單位為秒。

ErrMessage String Unexpected error

重試失敗的錯誤提示。

RetryTarget String srcDB

重試目標,傳回值:

  • srcDB:來源資料庫。
  • destDB:目標資料庫。
  • inner_module:DTS內部模組。
RetryTime Integer 3600

已重試時間,單位秒。

Module String 03

執行個體進展。

JobId String bi6e22ay243****

任務ID。

Retrying Boolean false

任務是否在重試中,傳回值:

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

錯誤碼協助文檔的ID。

MigrationErrHelpDocKey String DTS-RETRY-ERR-0046

錯誤碼協助文檔的Key。

MigrationErrCode String dts.retry.err.0046

錯誤碼的Code。

MigrationErrType String ForeignKey

錯誤碼的類型。

MigrationErrMsg String dts.retry.err.0046.msg

錯誤資訊。

MigrationErrWorkaround String dts.retry.err.0046.workaround

錯誤解決方案。

JobType String MIGRATION

DTS任務類型,取值:

  • MIGRATION:遷移。
  • SYNC:同步。
  • SUBSCRIBE:訂閱。
DuUsage Long 15

已使用的DTS專屬叢集資源,單位為Du。

CpuUsage String 1

執行個體的當前cpu使用率。單位:%。

MemUsage String 500

已使用的記憶體。單位:mb。

DedicatedClusterId String dtscluster_ft7y3**********

DTS專屬叢集ID。

ErrorDetails Array of ErrorDetail

報錯資訊。

ErrorCode String DTS-31009

錯誤碼。

HelpUrl String https://**.ali**.com/**

協助文檔的URL。

DataCloudStatus Object

物理遷移上雲的任務進程狀態。

Status String Migrating

任務的狀態,詳情請參見本介面請求參數Status的描述。

NeedUpgrade Boolean false

是否需要升級執行個體規格,傳回值:

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

任務進度,單位為百分比。

Progress String 1

已經完成遷移的表數量。

ErrorMessage String framework: DTS-31009: In process of processing data ****

任務失敗的錯誤提示。

ResourceGroupId String rg-acfmzawhxxc****

資源群組ID。

ResourceGroupDisplayName String default resource group

資源群組名稱。

MigrationErrMsg String dts.retry.err.0046.msg

錯誤資訊。

MigrationErrHelpDocId String 462133

錯誤碼協助文檔的ID。

MigrationErrWorkaround String dts.retry.err.0046.workaround

錯誤解決方案。

MigrationErrCode String dts.retry.err.0046

錯誤碼的Code。

MigrationErrHelpDocKey String DTS-RETRY-ERR-0046

錯誤碼協助文檔的Key。

MigrationErrType String ForeignKey

錯誤碼的類型。

EtlSafeCheckpoint String 1610540493

ETL任務安全位元點。

FullDataCheckStatus Object

全量校正狀態資訊。

Status String Checking

全量校正任務的狀態,傳回值為:

  • NotStarted:未開始。
  • Checking:校正中。
  • Failed:校正失敗。
  • Finished:校正完成。
Percent String 100

全量校正任務的進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

任務失敗的錯誤提示。

Progress String 1 rows/s (row: 5/5, table: 1/1)

全量校正任務進展。

IncDataCheckStatus Object

增量校正狀態資訊。

Status String Checking

增量校正任務的狀態,傳回值為:

  • Catched:無延遲。
  • NotStarted:未開始。
  • Checking:校正中。
  • Failed:校正失敗。
Percent String 95

增量校正任務的進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

任務失敗的錯誤提示。

Progress String 1 rows/s (row: 5/5, table: 1/1)

增量校正任務的進展。

DtsBisLabel String normal

DTS執行個體的環境標籤,傳回值為:

  • normal普通
  • online線上
MinDu double 1

Serverless執行個體的DU下限。

MaxDu double 16

Serverless執行個體的DU上限。

DuRealUsage String 12.0%

專屬叢集任務的DU使用率。

EtlDemoList Array of DtsJobStatus

工作清單及各任務執行詳情。

Status String Migrating

DTS執行個體狀態,取值:

遷移任務狀態:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Migrating:遷移中。
  • Suspending:暫停中。
  • MigrationFailed:遷移失敗。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。

同步任務狀態:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失敗。
  • Synchronizing:同步中。
  • Failed:同步失敗。
  • Suspending:暫停中。
  • Modifying:修改同步對象中。
  • ModifyFailed:修改同步對象失敗。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。

訂閱任務的狀態:

  • NotConfigured:未配置。
  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • Starting:啟動中。
  • Normal:正常。
  • Retrying:重試中。
  • Abnormal:異常。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。
OriginType String DTS任務

標註任務來源:

  • PTS任務
  • DMS任務
  • DTS任務
DtsJobName String RDS間遷移

遷移、同步或訂閱任務名稱。

Delay Long 0

增量資料移轉或者同步的延遲時間。

說明 如查詢遷移任務,該參數的單位為毫秒,如查詢同步任務,該參數的單位為秒。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].

任務失敗的錯誤提示。

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

執行個體的到期時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

說明 PayType參數的傳回值為PrePaid時才會返回本參數。
DtsJobId String i03e3zty16i****

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

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

任務建立時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

PayType String PrePaid

執行個體的付費類型,傳回值:

  • PrePaid:訂用帳戶(預付費)。
  • PostPaid:隨用隨付(後付費)。
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

DTS預留參數,格式為JSON串,您可以傳入本參數實現特殊需求(例如是否自動啟動預檢查)。更多資訊,請參見MigrationReserved參數說明

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

下遊消費用戶端資訊,由IP地址和DTS隨機產生的隨機數組成。

DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

遷移、同步或訂閱對象,詳細定義說明,請參見遷移、同步或訂閱對象說明

DtsJobClass String large

鏈路規格。

說明 關於各鏈路規格的說明及效能測試情況請參見資料移轉鏈路規格說明資料同步鏈路規格說明
ConsumptionCheckpoint String 2021-03-23T07:30:31Z

訂閱執行個體的下遊消費時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

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

訂閱執行個體中儲存的資料範圍的截止時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

AppName String new

是否為新版訂閱,new(新版訂閱)。

說明 該參數僅在新版訂閱執行個體中返回。
BeginTimestamp String 2021-03-15T08:25:34Z

訂閱執行個體中儲存的資料範圍的起始時間點,格式為yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

DtsInstanceID String dtsi03e3zty16i****

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

DtsJobDirection String Forward

同步方向,傳回值:

  • Forward:正向。
  • Reverse:反向。
說明 當資料同步執行個體的拓撲為雙向時,才會返回本參數。
Checkpoint String 1616899019

增量資料移轉的啟動位點或者同步位點,格式為Unix時間戳記,單位為秒。

TagList Array of DtsTag

標籤集合。

TagValue String testvalue

標籤的值。

TagKey String testkey

標籤的鍵。

DataInitializationStatus Object

全量資料移轉或初始化的狀態。

Status String Finished

全量資料移轉或初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:遷移或初始化中。
  • Failed:遷移或初始化失敗。
  • Finished:遷移或初始化完成。
Percent String 100

全量資料移轉或初始化進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量資料移轉或初始化失敗的錯誤提示。

Progress String 44755

已完成全量資料移轉或初始化的記錄數。

DataSynchronizationStatus Object

增量資料移轉或同步的狀態。

Status String Catched

增量資料移轉或同步狀態,傳回值為:

  • NotStarted:未啟動。
  • Migrating:遷移或同步中。
  • Failed:遷移或同步失敗。
  • Finished:遷移或同步完成。
  • Catched:無延遲。
NeedUpgrade Boolean true

是否需要升級執行個體規格,傳回值:

  • true:需要。
  • false:不需要。
說明 如需升級執行個體規格,請調用TransferInstanceClass進行升級。
Percent String 95

增量資料移轉或同步進度,單位為百分比。

Progress String 0/0

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

ErrorMessage String 任務失敗太久無法恢複

增量資料移轉或同步失敗的錯誤提示。

DataEtlStatus Object

ETL任務的狀態。

說明 配置ETL任務後,才會返回該參數集合。
Status String Finished

ETL任務狀態,傳回值為:

  • NotStarted:未啟動。
  • Migrating:執行中。
  • Failed:執行失敗。
  • Finished:完成。
  • Catched:無延遲。
Percent String 95

ETL任務進度,單位為百分比。

ErrorMessage String 任務失敗太久無法恢複

ETL任務失敗的錯誤提示。

Progress String 0/0

已完成ETL任務的記錄數。

DestinationEndpoint Object

目標執行個體的串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當目標執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

目標執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

目標執行個體中遷移對象所屬資料庫的名稱。

Ip String 172.16.88.***

目標執行個體的串連地址。

InstanceID String rm-bp1imrtn6fq7h****

目標執行個體ID。

Port String 3306

目標執行個體的資料庫服務連接埠。

InstanceType String RDS

目標執行個體類型。

UserName String dtstest

目標執行個體的資料庫帳號。

EngineName String MySQL

目標執行個體的資料庫類型。

MigrationMode Object

遷移類型或同步初始化類型。

DataInitialization Boolean true

是否執行全量資料移轉或全量資料初始化,傳回值:

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

是否執行增量資料移轉或同步,傳回值:

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

是否執行庫表結構遷移或初始化,傳回值:

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

遷移或同步鏈路的效能資訊。

Rps String 100

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

Flow String 1

每秒遷移或同步資料的流量,單位為MB/s。

PrecheckStatus Object

預檢查狀態。

Status String Finished

預檢查狀態,傳回值:

  • NotStarted:未啟動。
  • Suspending:暫停中。
  • Checking:預檢查中。
  • Failed:預檢查失敗。
  • Finished:預檢查完成。
Percent String 100

預檢查整體進度,單位為百分比。

ErrorMessage String CHECK__ERROR_SAME_OBJ.

預檢查失敗的提示資訊。

Detail Array of PrecheckDetail

各預檢查項的執行情況。

CheckResult String Success

檢查結果,傳回值:

  • Success:通過該項檢查。
  • Failed:未通過該項檢查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

預檢查專案描述。

CheckItem String CHECK_CONN_SRC

預檢查專案。

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

預檢查未通過時對應的修複方法。

說明 CheckResult參數傳回值為Failed時,才會返回本參數。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

預檢查未通過的錯誤提示。

說明 CheckResult參數傳回值為Failed時,才會返回本參數。
ReverseJob Object

反向同步任務執行詳情。

說明 當該任務為資料同步,且拓撲類型為雙向時,才會返回該參數合集。
Status String Synchronizing

反向同步任務狀態,取值:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • PreCheckPass:預檢查通過。
  • NotConfigured:未配置。
  • Initializing:同步初始化中。
  • InitializeFailed:同步初始化失敗。
  • Synchronizing:同步中。
  • Failed:同步失敗。
  • Suspending:暫停中。
  • Modifying:修改同步對象中。
  • ModifyFailed:修改同步對象失敗。
  • Finished:完成。
  • Retrying:重試中。
  • Upgrade:升級中。
  • Locked:鎖定中。
  • Downgrade:降級中。
DtsJobName String RDS間遷移

同步任務名稱。

Delay Long 0

增量資料同步的延遲時間,單位為秒。

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

任務失敗的錯誤提示。

DtsJobId String i03e3zty16i****

同步任務ID。

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

執行個體的到期時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

說明 PayType參數的傳回值為PrePaid時才會返回本參數。
CreateTime String 2021-03-16T08:01:19Z

任務建立時間,yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

PayType String PostPaid

執行個體的付費類型,傳回值:

  • PrePaid:訂用帳戶(預付費)。
  • PostPaid:隨用隨付(後付費)。
Reserved String {\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}

DTS預留參數,格式為JSON串,您可以傳入本參數實現特殊需求(例如是否自動啟動預檢查)。更多資訊,請參見MigrationReserved參數說明

DbObject String {"dtstestdata": { "name": "dtstestdata", "all": true }}

同步對象的庫表結構定義,格式為JSON串,且支援一定的Regex。更多相關介紹和樣本,請參見遷移、同步或訂閱對象配置說明。

DtsJobClass String large

鏈路規格。

說明 關於各鏈路規格的說明及效能測試情況請參見資料同步鏈路規格說明
DtsInstanceID String dtsi03e3zty16i****

同步執行個體ID。

DtsJobDirection String Reverse

同步方向,固定為Reverse(反向)。

Checkpoint String 1616980369

增量資料同步位點,格式為Unix時間戳記,單位為秒。

DataInitializationStatus Object

全量資料初始化的狀態。

Status String Finished

全量資料初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:初始化中。
  • Failed:初始化失敗。
  • Finished:初始化完成。
Percent String 100

全量資料初始化進度,單位為百分比。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量資料初始化失敗的錯誤提示。

Progress String 43071

已完成全量資料初始化的記錄數。

DataSynchronizationStatus Object

增量資料同步的狀態。

Status String Migrating

增量資料同步狀態。

NeedUpgrade Boolean true

是否需要升級執行個體規格,傳回值:

  • true:需要。
  • false:不需要。
說明 如需升級執行個體規格,請調用TransferInstanceClass進行升級。
Percent String 100

增量資料同步進度,單位為百分比。

Progress String 20001

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

ErrorMessage String 任務失敗太久無法恢複

增量資料同步失敗的錯誤提示。

DestinationEndpoint Object

目標執行個體的串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當目標執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

目標執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

目標執行個體中同步對象所屬資料庫的名稱。

Ip String 172.16.88.***

目標執行個體的串連地址。

InstanceID String rm-bp1162kryivb8****

目標執行個體ID。

Port String 3306

目標執行個體的資料庫服務連接埠。

InstanceType String RDS

目標執行個體類型。

UserName String dtstest

目標執行個體的資料庫帳號。

EngineName String MySQL

目標執行個體的資料庫類型。

MigrationMode Object

遷移類型或同步初始化類型。

DataInitialization Boolean true

是否執行全量資料移轉或全量資料初始化,傳回值:

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

是否執行增量資料移轉或同步,傳回值:

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

是否執行庫表結構遷移或初始化,傳回值:

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

遷移或同步鏈路的效能資訊。

Rps String 100

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

Flow String 1

每秒遷移或同步資料的流量,單位為MB/s。

PrecheckStatus Object

預檢查狀態。

Status String Finished

預檢查狀態,傳回值:

  • NotStarted:未啟動。
  • Suspending:暫停中。
  • Checking:預檢查中。
  • Failed:預檢查失敗。
  • Finished:預檢查完成。
Percent String 100

預檢查整體進度,單位為百分比。

ErrorMessage String CHECK__ERROR_SAME_OBJ

預檢查失敗的提示資訊。

Detail Array of PrecheckDetail

各預檢查項的執行情況。

CheckResult String Success

檢查結果,傳回值:

  • Success:通過該項檢查。
  • Failed:未通過該項檢查。
CheckItemDescription String CHECK_CONN_SRC_DETAIL

預檢查專案描述。

CheckItem String CHECK_CONN_SRC

預檢查專案。

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

預檢查未通過時對應的修複方法。

說明 CheckResult參數傳回值為Failed時,才會返回本參數。
FailedReason String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

預檢查未通過的錯誤提示。

說明 CheckResult參數傳回值為Failed時,才會返回本參數。
SourceEndpoint Object

源執行個體串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當源執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

源執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

源執行個體中遷移對象所屬資料庫的名稱。

Ip String 172.16.88.***

源執行個體的串連地址。

InstanceID String rm-bp1imrtn6fq7h****

源執行個體ID。

Port String 3306

源執行個體的資料庫服務連接埠。

InstanceType String RDS

源執行個體類型。

UserName String dtstest

源執行個體的資料庫帳號。

EngineName String MySQL

源執行個體的資料庫類型。

StructureInitializationStatus Object

庫表結構初始化狀態。

Status String Finished

庫表結構初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:初始化中。
  • Failed:初始化失敗。
  • Finished:初始化完成。
Percent String 100

庫表結構初始化進度,單位為百分比。

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

庫表結構初始化失敗的錯誤提示。

Progress String 1

已完成庫表結構初始化的表的數量。

EtlSafeCheckpoint String 1610540493

ETL任務安全位元點。

SourceEndpoint Object

源執行個體串連資訊。

SslSolutionEnum String DISABLE

是否使用SSL安全連線,傳回值:

  • DISABLE:不使用SSL安全連線。
  • ENABLE_WITH_CERTIFICATE:使用SSL安全連線,並上傳CA認證。
  • ENABLE_ONLY_4_MONGODB_ALTAS:使用SSL安全連線AWS MongoDB Altas。
  • ENABLE_ONLY_4_KAFKA_SCRAM_SHA_256:使用SCRAM-SHA-256串連Kafka。
OracleSID String testsid

Oracle資料庫的SID資訊。

說明 當源執行個體的EngineName取值為Oracle,且Oracle資料庫為非RAC執行個體時,才會返回本參數。
Region String cn-hangzhou

源執行個體所在地區,詳情請參見支援的地區列表

DatabaseName String dtstestdata

源執行個體中遷移對象所屬資料庫的名稱。

Ip String 172.16.88.***

源執行個體的串連地址。

InstanceID String rm-bp1162kryivb8****

源執行個體ID。

Port String 3306

源執行個體的資料庫服務連接埠。

InstanceType String RDS

源執行個體類型。

UserName String dtstest

源執行個體的資料庫帳號。

EngineName String MySQL

源執行個體的資料庫類型。

StructureInitializationStatus Object

庫表結構遷移或初始化狀態。

Status String Finished

庫表結構遷移或初始化狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:遷移或初始化中。
  • Failed:遷移或初始化失敗。
  • Finished:遷移或初始化完成。
Percent String 100

庫表結構遷移或初始化進度,單位為百分比。

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

庫表結構遷移或初始化失敗的錯誤提示。

Progress String 1

已完成庫表結構遷移或初始化的表的數量。

RetryState Object

由於任務異常,DTS正在重試。

RetryCount Integer 5

已重試次數。

MaxRetryTime Integer 7200

最大重試時間,單位為秒。

ErrMessage String Unexpected error

重試失敗的錯誤提示。

RetryTarget String srcDB

重試目標,傳回值:

  • srcDB:來源資料庫。
  • destDB:目標資料庫。
  • inner_module:DTS內部模組。
RetryTime Integer 3600

已重試時間,單位秒。

Module String 03

執行個體進展。

JobId String bi6e22ay243****

任務ID。

Retrying Boolean false

任務是否在重試中,傳回值:

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

DTS執行個體的任務類型,取值:

  • MIGRATION:遷移。
  • SYNC:同步。
  • SUBSCRIBE:訂閱。
ResourceGroupId String rg-acfmzawhxxc****

資源群組ID。

ResourceGroupDisplayName String default resource group

資源群組名稱。

EtlSafeCheckpoint String 1610540493

ETL任務安全位元點。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=DescribeDtsJobs
&Region=cn-hangzhou
&<公用請求參數>

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDtsJobsResponse>
    <TotalRecordCount>15</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <DtsJobList>
        <Status>Migrating</Status>
        <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>44755</Progress>
            <Percent>100</Percent>
        </DataInitializationStatus>
        <DbObject>{"DTSTEST":{"name":"dtstest","all":true,"state":"normal","edit":false}}</DbObject>
        <CreateTime>2021-03-16T08:01:19Z</CreateTime>
        <DtsJobName>RDS間遷移</DtsJobName>
        <ReverseJob>
            <PrecheckStatus/>
            <DataInitializationStatus/>
            <DestinationEndpoint/>
            <SourceEndpoint/>
            <Performance/>
            <MigrationMode/>
            <StructureInitializationStatus/>
            <DataSynchronizationStatus/>
        </ReverseJob>
        <PayType>PrePaid</PayType>
        <DtsInstanceID>dtsi03e3zty16i****</DtsInstanceID>
        <Delay>0</Delay>
        <MigrationMode>
            <DataInitialization>true</DataInitialization>
            <DataSynchronization>true</DataSynchronization>
            <StructureInitialization>true</StructureInitialization>
        </MigrationMode>
        <PrecheckStatus>
            <Status>Finished</Status>
            <Percent>100</Percent>
            <Detail>
                <CheckItem>CHECK_CONN_SRC</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_CONN_SRC_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_CONN_DEST</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_CONN_DEST_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_AUTH_SRC</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_AUTH_SRC_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_AUTH_DEST</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_AUTH_DEST_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_BINLOG_ON</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_BINLOG_ON_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_BINLOG_MODE</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_BINLOG_MODE_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_BINLOG_ROW_IMAGE</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_BINLOG_ROW_IMAGE_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_SERVER_ID</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_SERVER_ID_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_BINLOG_EXIST</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_BINLOG_EXIST_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_ENGINE</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_ENGINE_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_MYSQL_PASSOWRD_FORMAT</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_MYSQL_PASSOWRD_FORMAT_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_SRC</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_SRC_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_SAME_OBJ</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_SAME_OBJ_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_SQL_MODE</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_SQL_MODE_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_SAME_USER</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_SAME_USER_DETAIL</CheckItemDescription>
            </Detail>
            <Detail>
                <CheckItem>CHECK_TOPOLOGY</CheckItem>
                <CheckResult>Success</CheckResult>
                <CheckItemDescription>CHECK_TOPOLOGY_DETAIL</CheckItemDescription>
            </Detail>
        </PrecheckStatus>
        <DtsJobClass>large</DtsJobClass>
        <Checkpoint>1616902385</Checkpoint>
        <DtsJobId>i03e3zty16i****</DtsJobId>
        <DestinationEndpoint>
            <UserName>dtstest</UserName>
            <InstanceID>rm-bp1imrtn6fq7h****</InstanceID>
            <SslSolutionEnum>DISABLE</SslSolutionEnum>
            <Port>3306</Port>
            <DatabaseName/>
            <Region>cn-hangzhou</Region>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </DestinationEndpoint>
        <SourceEndpoint>
            <UserName>dtstest</UserName>
            <InstanceID>rm-bp1162kryivb8****</InstanceID>
            <SslSolutionEnum>DISABLE</SslSolutionEnum>
            <Port>3306</Port>
            <Region>cn-hangzhou</Region>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </SourceEndpoint>
        <TagList>
            <TagKey>testkey</TagKey>
            <TagValue>testvalue</TagValue>
        </TagList>
        <Performance/>
        <Reserved>{"srcHostPorts":"","whitelist.dms.online.ddl.enable":false,"filterDDL":false,"sqlparser.dms.original.ddl":true,"srcOracleType":"sid","maxRetryTime":43200,"destSSL":"0","destOracleType":"sid","srcSSL":"0","dbListCaseChangeMode":"default","SourceEngineVersion":"8.0.18","srcNetType":"VPC","destNetType":"VPC","srcVpcNetMappingInst":"172.16.1**.**:10803","destVpcNetMappingInst":"172.16.1**.**:11077","useJobTask":"1"}</Reserved>
        <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
        </StructureInitializationStatus>
        <DataSynchronizationStatus>
            <Status>Catched</Status>
            <Progress>0/0</Progress>
            <Percent>95</Percent>
        </DataSynchronizationStatus>
    </DtsJobList>
    <RequestId>621BB4F8-3016-4FAA-8D5A-5D3163CC****</RequestId>
    <PageNumber>2</PageNumber>
    <HttpStatusCode>200</HttpStatusCode>
    <Success>true</Success>
</DescribeDtsJobsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 15,
  "PageRecordCount" : 1,
  "DtsJobList" : [ {
    "Status" : "Migrating",
    "DataInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "44755",
      "Percent" : "100"
    },
    "DbObject" : "{\"DTSTEST\":{\"name\":\"dtstest\",\"all\":true,\"state\":\"normal\",\"edit\":false}}",
    "CreateTime" : "2021-03-16T08:01:19Z",
    "DtsJobName" : "RDS間遷移",
    "ReverseJob" : {
      "PrecheckStatus" : { },
      "DataInitializationStatus" : { },
      "DestinationEndpoint" : { },
      "SourceEndpoint" : { },
      "Performance" : { },
      "MigrationMode" : { },
      "StructureInitializationStatus" : { },
      "DataSynchronizationStatus" : { }
    },
    "PayType" : "PrePaid",
    "DtsInstanceID" : "dtsi03e3zty16i****",
    "Delay" : 0,
    "MigrationMode" : {
      "DataInitialization" : true,
      "DataSynchronization" : true,
      "StructureInitialization" : true
    },
    "PrecheckStatus" : {
      "Status" : "Finished",
      "Percent" : "100",
      "Detail" : [ {
        "CheckItem" : "CHECK_CONN_SRC",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_CONN_SRC_DETAIL"
      }, {
        "CheckItem" : "CHECK_CONN_DEST",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_CONN_DEST_DETAIL"
      }, {
        "CheckItem" : "CHECK_AUTH_SRC",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_AUTH_SRC_DETAIL"
      }, {
        "CheckItem" : "CHECK_AUTH_DEST",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_AUTH_DEST_DETAIL"
      }, {
        "CheckItem" : "CHECK_BINLOG_ON",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_BINLOG_ON_DETAIL"
      }, {
        "CheckItem" : "CHECK_BINLOG_MODE",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_BINLOG_MODE_DETAIL"
      }, {
        "CheckItem" : "CHECK_BINLOG_ROW_IMAGE",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_BINLOG_ROW_IMAGE_DETAIL"
      }, {
        "CheckItem" : "CHECK_SERVER_ID",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_SERVER_ID_DETAIL"
      }, {
        "CheckItem" : "CHECK_BINLOG_EXIST",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_BINLOG_EXIST_DETAIL"
      }, {
        "CheckItem" : "CHECK_ENGINE",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_ENGINE_DETAIL"
      }, {
        "CheckItem" : "CHECK_MYSQL_PASSOWRD_FORMAT",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_MYSQL_PASSOWRD_FORMAT_DETAIL"
      }, {
        "CheckItem" : "CHECK_SRC",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_SRC_DETAIL"
      }, {
        "CheckItem" : "CHECK_SAME_OBJ",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_SAME_OBJ_DETAIL"
      }, {
        "CheckItem" : "CHECK_SQL_MODE",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_SQL_MODE_DETAIL"
      }, {
        "CheckItem" : "CHECK_SAME_USER",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_SAME_USER_DETAIL"
      }, {
        "CheckItem" : "CHECK_TOPOLOGY",
        "CheckResult" : "Success",
        "CheckItemDescription" : "CHECK_TOPOLOGY_DETAIL"
      } ]
    },
    "DtsJobClass" : "large",
    "Checkpoint" : "1616902385",
    "DtsJobId" : "i03e3zty16i****",
    "DestinationEndpoint" : {
      "UserName" : "dtstest",
      "InstanceID" : "rm-bp1imrtn6fq7h****",
      "SslSolutionEnum" : "DISABLE",
      "Port" : "3306",
      "DatabaseName" : "",
      "Region" : "cn-hangzhou",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "SourceEndpoint" : {
      "UserName" : "dtstest",
      "InstanceID" : "rm-bp1162kryivb8****",
      "SslSolutionEnum" : "DISABLE",
      "Port" : "3306",
      "Region" : "cn-hangzhou",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "TagList" : [ {
      "TagKey" : "testkey",
      "TagValue" : "testvalue"
    } ],
    "Performance" : { },
    "Reserved" : "{\"srcHostPorts\":\"\",\"whitelist.dms.online.ddl.enable\":false,\"filterDDL\":false,\"sqlparser.dms.original.ddl\":true,\"srcOracleType\":\"sid\",\"maxRetryTime\":43200,\"destSSL\":\"0\",\"destOracleType\":\"sid\",\"srcSSL\":\"0\",\"dbListCaseChangeMode\":\"default\",\"SourceEngineVersion\":\"8.0.18\",\"srcNetType\":\"VPC\",\"destNetType\":\"VPC\",\"srcVpcNetMappingInst\":\"172.16.1**.**:10803\",\"destVpcNetMappingInst\":\"172.16.1**.**:11077\",\"useJobTask\":\"1\"}",
    "StructureInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "1",
      "Percent" : "100"
    },
    "DataSynchronizationStatus" : {
      "Status" : "Catched",
      "Progress" : "0/0",
      "Percent" : "95"
    }
  } ],
  "RequestId" : "621BB4F8-3016-4FAA-8D5A-5D3163CC****",
  "PageNumber" : 2,
  "HttpStatusCode" : 200,
  "Success" : true
}

錯誤碼

HttpCode

錯誤碼

錯誤資訊

描述

400 Throttling.User Request was denied due to user flow control. 由於請求頻次達到閾值,請求被拒絕,請稍後重試。
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由於服務端響應逾時或者不可用導致請求失敗,請重試,重試後仍失敗請聯絡支援人員。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 簽名已經到期,請更新簽名

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