購買同步執行個體 - Data Transmission Service

請確保在使用該介面前，已充分瞭解雲資料庫DTS產品的收費方式和價格。

購買完成後，需要調用介面ConfigureSynchronizationJob配置同步任務，才能成功啟動同步任務。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	CreateSynchronizationJob	系統規定參數，取值：CreateSynchronizationJob。
DestRegion	String	是	cn-hangzhou	資料同步的目標資料庫所屬地區的ID，詳情請參見支援的地區列表。說明如果SourceRegion參數傳入的地區為中國香港或海外地區，那麼本參數須傳入相同地區的ID。
PayType	String	是	PostPaid	付費類型。 PrePaid：預付費。 PostPaid：隨用隨付，預設付費類型。
SourceRegion	String	是	cn-hangzhou	資料同步的來源資料庫所屬地區的ID，詳情請參見支援的地區列表。
SynchronizationJobClass	String	是	small	資料同步鏈路的規格，取值：micro、small、medium、large。說明關於各鏈路規格的說明及效能測試情況請參見資料同步鏈路規格說明。
RegionId	String	否	cn-hangzhou	資料同步執行個體地區的ID，與DestRegion參數保持一致。
Topology	String	否	oneway	同步拓撲，取值： oneway：單向同步 bidirectional：雙向同步。說明預設取值為oneway。當SourceEndpoint.InstanceType和DestinationEndpoint.InstanceType參數取值為MySQL、PolarDB或Redis時，本參數才可以傳入bidirectional。
Period	String	否	Year	預付費執行個體的計費方式，取值： Year：包年。 Month：包月。說明當付費類型為PrePaid（預付費）時，該參數才有效且必須傳入。
UsedTime	Integer	否	1	預付費執行個體購買時間長度。當計費方式為Year（包年）時，取值範圍為1~5。當計費方式為Month（包月）時，取值範圍為1~60。說明當付費類型為PrePaid（預付費）時，該參數才有效且必須傳入。
ClientToken	String	否	0c593ea1-3bea-11e9-b96b-88e9fe63****	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken只支援ASCII字元，且不能超過64個字元。
SourceEndpoint.InstanceType	String	否	MySQL	源庫的執行個體類型，取值： MySQL：MySQL資料庫（包括RDS MySQL和自建MySQL）。 PolarDB：PolarDB叢集（僅支援MySQL或相容Oracle文法的引擎）。 Redis：Redis資料庫。 DRDS：雲原生分散式資料庫PolarDB-X 1.0。說明預設取值為MySQL。關於支援的源庫和目標庫對應情況，請參見支援的資料庫、同步初始化類型和同步拓撲。
DestinationEndpoint.InstanceType	String	否	MySQL	目標庫的執行個體類型，取值： MySQL：MySQL資料庫（包括RDS MySQL和自建MySQL）。 PolarDB：PolarDB叢集（僅支援MySQL或相容Oracle文法的引擎）。 Redis：Redis資料庫。 MaxCompute：MaxCompute執行個體。說明預設取值為MySQL。關於支援的源庫和目標庫對應情況，請參見支援的資料庫、同步初始化類型和同步拓撲。
networkType	String	否	Intranet	資料轉送網路類型，固定取值為Intranet（專線）。
AccountId	String	否	12323344****	阿里雲主帳號ID，無需設定，該參數即將下線。
DBInstanceCount	Integer	否	3	當SourceEndpoint.InstanceType傳入DRDS時，您需要傳入本參數來指定源PolarDB-X下掛的私人定製RDS執行個體數量，預設值為1。

返回資料

名稱	類型	樣本值	描述
ErrCode	String	InternalError	調用出錯時返回的錯誤碼。
ErrMessage	String	The request processing has failed due to some unknown error.	調用錯誤時返回對應的錯誤資訊。
RequestId	String	9056C8B0-5799-493A-9655-70F607B8****	請求ID。
Success	String	true	請求是否成功。
SynchronizationJobId	String	dtshvj11k25255****	資料同步執行個體ID。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=CreateSynchronizationJob
&SourceRegion=cn-hangzhou
&DestRegion=cn-hangzhou
&SynchronizationJobClass=small
&PayType=PostPaid 
&<公用請求參數>

正常返回樣本

XML格式

<CreateSynchronizationJobResponse>
      <SynchronizationJobId>dtshvj11k25255****</SynchronizationJobId>
      <RequestId>9056C8B0-5799-493A-9655-70F607B8****</RequestId>
      <Success>true</Success>
</CreateSynchronizationJobResponse>

JSON格式

{
	"SynchronizationJobId": "dtshvj11k25255****",
	"RequestId": "9056C8B0-5799-493A-9655-70F607B8****",
	"Success": true
}

錯誤碼

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