全部產品
Search
文件中心

Data Transmission Service:購買DTS執行個體

更新時間:Feb 08, 2025

調用CreateDtsInstance介面購買DTS執行個體。

  • 請確保在使用該介面前,已充分瞭解雲資料庫DTS產品的收費方式和價格
  • 專屬叢集的任務僅支援先配置任務後購買執行個體,您可以調用ConfigureDtsJob介面配置任務。

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String CreateDtsInstance

系統規定參數。取值:CreateDtsInstance

JobId String bi6e22ay243****

調用ConfigureDtsJob介面獲得的任務ID(DtsJobId)。

說明 傳入本參數後,則無需再傳SourceRegionDestinationRegionTypeSourceEndpointEngineNameDestinationEndpointEngineName參數。即使傳入也以JobId中的配置為準。
InstanceClass String xxlarge

遷移或同步執行個體的規格。

  • 遷移執行個體支援的規格:xxlargexlargelargemediumsmall
  • 同步執行個體支援的規格:largemediumsmallmicro
說明 不同規格對應的效能說明,請參見資料移轉鏈路規格說明資料同步鏈路規格說明
PayType String PrePaid

支付類型:

  • PrePaid:預付費。
  • PostPaid:後付費。
說明 更正:本參數為必填參數。
Period String Month

預付費執行個體的計費方式,取值:Year(年)Month(月)。

說明 PayTypePrePaid(預付費)時,該參數才有效且必須傳入。
SyncArchitecture String oneway

同步拓撲,取值:

  • oneway:單向同步,為預設值。
  • bidirectional:雙向同步。
AutoStart Boolean false

購買完成後是否自動啟動任務,取值:

  • false:否,為預設值。
  • true:是。
說明 僅當參數JobId傳入有效任務ID時,本參數取值為true才會生效。
UsedTime Integer 5

預付費執行個體購買時間長度。

  • PeriodMonth時,取值為:1、2、3、4、5、6、7、8、9。
  • PeriodYear時,取值為:1、2、3、5。
    說明
    • PayTypePrePaid(預付費)時,該參數才有效且必須傳入。
    • 預付費執行個體的計費方式,您可在參數Period中進行設定。
Quantity Integer 1

購買執行個體數量。

說明 當前單次調用最多支援購買1個。
AutoPay Boolean false

到期是否自動續約,取值:

  • false:否,為預設值。
  • true:是。
Type String SYNC

執行個體類型,取值為:

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

    說明 本參數或JobId必須傳入其中之一。

DatabaseCount Integer 3

PolarDB-X下的私人定製RDS執行個體的數量,預設值為1

說明 SourceEndpointEngineNamedrds時需要傳入該參數。
SourceRegion String cn-hangzhou

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

說明 本參數或JobId必須傳入其中之一。
DestinationRegion String cn-hangzhou

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

說明 本參數或JobId必須傳入其中之一。
SourceEndpointEngineName String MySQL

源執行個體資料庫引擎類型。

  • MySQL:MySQL資料庫(包括RDS MySQL和自建MySQL)。
  • PolarDB:PolarDB MySQL。
  • polardb_o:PolarDB O引擎。
  • polardb_pg:PolarDB PostgreSQL。
  • Redis:Redis資料庫,包括雲資料庫Tair(相容Redis)和自建Redis。
  • DRDS:雲原生分散式資料庫PolarDB-X 1.0和2.0。
  • PostgreSQL:自建PostgreSQL。
  • odps:MaxCompute。
  • oracle:自建Oracle。
  • mongodb:MongoDB資料庫(包括ApsaraDB for MongoDB和自建MongoDB)。
  • tidb:TiDB資料庫。
  • ADS:雲原生數倉 AnalyticDB MySQL 2.0。
  • ADB30:雲原生數倉 AnalyticDB MySQL 3.0。
  • Greenplum:雲原生數倉 AnalyticDB PostgreSQL。
  • MSSQL:SQL Server資料庫(包括RDS SQL Server和自建SQL Server)。
  • kafka:Kafka資料庫(包括訊息佇列Kafka版和自建Kafka)。
  • DataHub:阿里雲流式資料服務DataHub。
  • DB2:自建DB2 LUW。
  • as400:AS/400。
  • Tablestore:Table StoreTablestore。
  • OceanBase:OceanBase(MySQL),僅遷移執行個體支援。
說明
DestinationEndpointEngineName String MySQL

目標資料庫引擎類型。

  • MySQL:MySQL資料庫(包括RDS MySQL和自建MySQL)。
  • PolarDB:PolarDB MySQL。
  • polardb_o:PolarDB O引擎。
  • polardb_pg:PolarDB PostgreSQL。
  • Redis:Redis資料庫,包括雲資料庫Tair(相容Redis)和自建Redis。
  • DRDS:雲原生分散式資料庫PolarDB-X 1.0和2.0。
  • PostgreSQL:自建PostgreSQL。
  • odps:MaxCompute。
  • oracle:自建Oracle。
  • mongodb:MongoDB資料庫(包括ApsaraDB for MongoDB和自建MongoDB)。
  • tidb:TiDB資料庫。
  • ADS:雲原生數倉 AnalyticDB MySQL 2.0。
  • ADB30:雲原生數倉 AnalyticDB MySQL 3.0。
  • Greenplum:雲原生數倉 AnalyticDB PostgreSQL。
  • MSSQL:SQL Server資料庫(包括RDS SQL Server和自建SQL Server)。
  • kafka:Kafka資料庫(包括訊息佇列Kafka版和自建Kafka)。
  • DataHub:阿里雲流式資料服務DataHub。
  • DB2:自建DB2 LUW。
  • as400:AS/400。
  • Tablestore:Table StoreTablestore。
說明
ComputeUnit Integer 5

ETL的規格。單位為計算單元ComputeUnit(CU),1CU=1vCPU​+4 GB記憶體。取值範圍為大於等於2的整數。

RegionId String cn-hangzhou

執行個體所屬的地區,請參見支援的地區列表

FeeType String ONLY_CONFIGURATION_FEE

訂閱計費類型,ONLY_CONFIGURATION_FEE,僅收取配置費,免收資料流量費;CONFIGURATION_FEE_AND_DATA_FEE,將額外收取資料流量費用。

Du Integer 30

分配指定數量的DU資源給DTS專屬叢集上的DTS任務。取值範圍:1~100

說明
  • 傳入的值必須在DTS專屬叢集可用DU數範圍內。
  • 關於DTS專屬叢集的資訊,請參見什麼是DTS專屬叢集
ResourceGroupId String rg-acfmzawhxxc****

資源群組ID。

MinDu double 1

DU下限。

說明 僅Serverless執行個體支援。
MaxDu double 16

DU上限。

說明 僅Serverless執行個體支援。
DtsRegion String cn-hangzhou

執行個體的歸屬地區,需與RegionId保持一致。

返回資料

名稱

類型

樣本值

描述

RequestId String C166D79D-436B-45F0-B5A5-25E1****

請求ID。

ErrCode String InternalError

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

Success String true

請求是否成功。

JobId String bi6e22ay243****

任務ID。

ErrMessage String The request processing has failed due to some unknown error.

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

InstanceId String dtsbi6e22ay243****

執行個體ID。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=CreateDtsInstance
&InstanceClass=large
&PayType=PostPaid
&SyncArchitecture=oneway
&AutoStart=false
&Quantity=1
&AutoPay=false
&Type=SYNC
&SourceRegion=cn-hangzhou
&DestinationRegion=cn-hangzhou
&SourceEndpointEngineName=MySQL
&DestinationEndpointEngineName=MySQL
&RegionId=cn-hangzhou
&<公用請求參數>

正常返回樣本

XML格式

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

<CreateDtsInstanceResponse>
    <RequestId>C166D79D-436B-45F0-B5A5-25E1****</RequestId>
    <InstanceId>dtsmne11yo2j9n****</InstanceId>
    <Success>true</Success>
    <JobId>mne11yo2j9n****</JobId>
</CreateDtsInstanceResponse>

JSON格式

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

{
  "RequestId" : "C166D79D-436B-45F0-B5A5-25E1****",
  "InstanceId" : "dtsmne11yo2j9n****",
  "Success" : true,
  "JobId" : "mne11yo2j9n****"
}

錯誤碼

HttpCode

錯誤碼

錯誤資訊

描述

403 LXCreateOrderError Failed to create order, failure message: The module is invalid DTS跨境同步功能未全網開放,如果需要使用,請填寫<a href="https://page.aliyun.com/form/act409679078/index.htm" target="_blank">DTS跨境資料同步許可權申請表單</a>進行需求審核
403 LXCreateOrder.NotFoundPricePlan Pricing plan price result not found, please check the parameters of the task configuration. 建立訂單失敗,定價計劃沒有找到,可能的原因有:傳入的購買參數尚不支援購買、定價缺失、購買參數傳入錯誤。
403 LXPayOrder.InsufficientBalance Insufficient balance, order payment failed. 賬戶下餘額不足,無法完成支付,請儲值後重試。
403 DTS.Msg.LXCreateOrderError Failed to create order, failure message: The module is invalid DTS跨境同步功能未全網開放,如果需要使用,請填寫<a href="https://page.aliyun.com/form/act409679078/index.htm" target="_blank">DTS跨境資料同步許可權申請表單</a>進行需求審核
403 DTS.Msg.LXCreateOrder.NotFoundPricePlan Pricing plan price result not found, please check the parameters of the task configuration. 建立訂單失敗,定價計劃沒有找到,可能的原因有:傳入的購買參數尚不支援購買、定價缺失、購買參數傳入錯誤。
403 DTS.Msg.LXPayOrder.InsufficientBalance Insufficient balance, order payment failed. 賬戶下餘額不足,無法完成支付,請儲值後重試。
403 DTS.Msg.LXCreateOrderErrorIntl DTS supports cross-border data synchronization only in specific scenarios. To purchase a data synchronization instance used to synchronize data across countries, application for DTS cross-border data synchronization. DTS跨境同步功能未全網開放,如果需要使用,請填寫<a href="https://page-intl.aliyun.com/form/act1633074550/index.htm" target="_blank">DTS跨境資料同步許可權申請表單</a>進行需求審核
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 簽名已經到期,請更新簽名
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. 由於服務端響應逾時或者不可用導致請求失敗,請重試,重試後仍失敗請聯絡支援人員。

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