調用CreateSynchronizationJob接口購買一個數據同步實例。

請確保在使用該接口前，已充分了解云數據庫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。
說明
DestinationEndpoint.InstanceType String 否 MySQL

目標庫的實例類型，取值：

  • MySQL：MySQL數據庫（包括RDS MySQL和自建MySQL）。
  • PolarDB：PolarDB集群（僅支持MySQL或兼容Oracle語法的引擎）。
  • Redis：Redis數據庫。
  • MaxCompute：MaxCompute實例。
說明
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
}

錯誤碼

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