调用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
}

错误码

访问错误中心查看更多错误码。