调用ConfigureSynchronizationJob接口配置数据同步实例。

调用本接口前，已调用CreateSynchronizationJob接口创建了数据同步实例。

说明
  • 本接口调用成功后，数据同步实例会自动启动并执行预检查，您无需调用StartSynchronizationJob接口来启动。
  • 如果数据同步实例没有被成功启动，可能是预检查失败，您可以调用DescribeSynchronizationJobStatus接口查询数据同步实例的状态，获取预检查失败的错误提示并进行参数调整。调整完成后，您可以调用StartSynchronizationJob接口来重启数据同步实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ConfigureSynchronizationJob

系统规定参数，取值：ConfigureSynchronizationJob。

DataInitialization Boolean 是 true

是否执行全量数据初始化，取值：

  • true：是。
  • false：否。
说明 默认取值：true。
StructureInitialization Boolean 是 true

是否执行结构初始化，取值：

  • true：是。
  • false：否。
说明 默认取值：true。
SynchronizationJobId String 是 dtsz4ao1dor13d****

数据同步实例ID，可以通过调用DescribeSynchronizationJobs接口查询。

SynchronizationObjects String 是 [{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]

同步对象，格式为JSON串且支持一定的正则表达式，详细说明，请参见同步对象配置说明。

RegionId String 否 cn-hangzhou

数据同步实例所在地域的ID，详情请参见支持的地域列表。

SynchronizationJobName String 否 MySQL同步

同步任务名称。

说明 建议配置具有业务意义的名称（无唯一性要求），便于后续识别。
SynchronizationDirection String 否 Forward

同步方向，取值：

  • Forward：正向。
  • Reverse：反向。
说明
  • 默认取值为Forward。
  • 只有当数据同步实例的同步拓扑为双向同步时，本参数传入Reverse才会生效。
SourceEndpoint.InstanceId String 否 rm-bp1i99e8l7913****

源实例ID。
SourceEndpoint.InstanceType String 否 RDS

源实例类型，取值为：

  • RDS：阿里云RDS实例。
  • Redis：阿里云Redis实例。
  • PolarDB：阿里云PolarDB集群（仅支持MySQL或兼容Oracle语法的引擎）。
  • ECS：ECS上的自建数据库。
  • Express：通过专线接入的自建数据库。
  • dg：通过数据库网关DG接入的自建数据库。
  • cen：通过云企业网CEN接入的自建数据库。
说明 默认取值为RDS。
SourceEndpoint.IP String 否 172.16.88.***

源库的IP地址。

说明 当SourceEndpoint.InstanceType取值为ECS、Express、dg或cen时，本参数才可用且必须传入。
SourceEndpoint.Port String 否 3306

源库的数据库服务端口。

说明 当SourceEndpoint.InstanceType取值为ECS、Express、dg或cen时，本参数才可用且必须传入。
SourceEndpoint.UserName String 否 dtstestaccount

源库的数据库账号。

说明
  • 当SourceEndpoint.InstanceType取值为ECS、Express、dg或cen时，本参数才可用且必须传入。
  • 当SourceEndpoint.InstanceType取值为Redis时，本参数无需传入。
  • 同步不同的数据库所需的权限有所差异，详情请参见DTS数据同步方案概览中对应的配置案例。
SourceEndpoint.Password String 否 Test123456

源库数据库账号密码。

说明 当SourceEndpoint.InstanceType取值为ECS、Express、dg或cen时，本参数必须传入。
DestinationEndpoint.InstanceId String 否 rm-bp1r46452ai50****

同步目标实例的实例ID

说明 当DestinationEndpoint.InstanceType取值为MaxCompute或DataHub时，本参数传入MaxCompute实例或DataHub的Project名称。

当目标实例为阿里云分析型数据库MySQL版时，传入分析型数据库MySQL版的集群ID。
DestinationEndpoint.InstanceType String 否 RDS

目标实例类型，取值为：

  • Redis：阿里云Redis实例。
  • RDS：阿里云RDS实例。
  • PolarDB：阿里云PolarDB集群（仅支持MySQL或兼容Oracle语法的引擎）。
  • ECS：ECS上的自建数据库。
  • Express：通过专线接入的本地数据库。
  • DataHub：阿里云DataHub实例。
  • MaxCompute：阿里云MaxCompute实例。
  • AnalyticDB：云原生数据仓库AnalyticDB MySQL 3.0和2.0版本。
  • Greenplum：云原生数据仓库ADB PostgreSQL版（原分析型数据库PostgreSQL版）。
说明 默认取值为RDS。
DestinationEndpoint.IP String 否 172.16.88.***

目标库的IP地址。

说明 当DestinationEndpoint.InstanceType取值为Express、dg或cen时，本参数必须传入本参数才可用且必须传入。
DestinationEndpoint.Port String 否 3306

目标库的数据库服务端口。

说明 当DestinationEndpoint.InstanceType取值为ECS、Express、dg或cen时，本参数才可用且必须传入。
DestinationEndpoint.UserName String 否 dtstestaccount

目标库的数据库账号。

说明
  • 同步不同的数据库所需的权限有所差异，详情请参见DTS数据同步方案概览中对应的配置案例。
  • 当DestinationEndpoint.InstanceType取值为ECS、Express、dg或cen时，本参数必须传入。
  • 当DestinationEndpoint.InstanceType取值为RDS且数据库版本为MySQL 5.5或MySQL 5.6，无需传入本参数和DestinationEndpoint.Password参数。
  • 当DestinationEndpoint.InstanceType取值为Redis时，无需传入本参数。
DestinationEndpoint.Password String 否 Test654321

目标库数据库账号密码。

说明
  • 当DestinationEndpoint.InstanceType取值为ECS、Express、dg或cen时，本参数必须传入。
SourceEndpoint.OwnerID String 否 140692647406****

源RDS实例所属的阿里云账号ID。

说明 传入本参数即代表执行跨阿里云账号的数据同步，同时您还需要传入SourceEndpoint.Role参数。
SourceEndpoint.Role String 否 ram-for-dts

源实例所属云账号配置的角色名称。

说明 执行跨阿里云账号的数据同步时须传入本参数，该角色所需的权限及授权方式请参见跨阿里云账号数据迁移或同步时如何配置RAM授权。
PartitionKey.ModifyTime_Year Boolean 否 true

设置增量日志表是否包含以增量更新时间对应年份信息定义的分区，取值：true或false。

说明 当DestinationEndpoint.InstanceType参数取值为Maxcompute时，本参数才可用。
PartitionKey.ModifyTime_Month Boolean 否 true

设置增量日志表是否包含以增量更新时间对应月份信息定义的分区，取值：true或false。

说明 当DestinationEndpoint.InstanceType参数取值为Maxcompute时，本参数才可用。
PartitionKey.ModifyTime_Day Boolean 否 true

设置增量日志表是否包含以增量更新时间对应日期信息定义的分区，取值：true或false。

说明 当DestinationEndpoint.InstanceType参数取值为Maxcompute时，本参数才可用。
PartitionKey.ModifyTime_Hour Boolean 否 true

设置增量日志表是否包含以增量更新时间对应小时信息定义的分区，取值：true或false。

说明 当DestinationEndpoint.InstanceType参数取值为Maxcompute时，本参数才可用。
PartitionKey.ModifyTime_Minute Boolean 否 true

设置增量日志表是否包含以增量更新时间对应分钟信息定义的分区，取值：true或false。

说明 当DestinationEndpoint.InstanceType参数取值为Maxcompute时，本参数才可用。
MigrationReserved String 否 { "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }

DTS预留参数，格式为JSON串，您可以传入本参数实现特殊需求（例如是否自动启动预检查）。更多信息，请参见MigrationReserved参数说明。

说明 如在Redis企业版实例间的数据同步可使用该参数，更多信息，请参见调用OpenAPI配置Redis企业版实例间单向或双向数据同步。
Checkpoint String 否 1610540493

同步位点。
AccountId String 否 12323344****

阿里云主账号ID，无需设置，该参数即将下线。
SourceEndpoint.DatabaseName String 否 dtstestdata

源实例中的同步对象所属数据库名称。
DestinationEndpoint.DataBaseName String 否 dtstestdata

目标实例中的同步对象所属数据库名称。

返回数据

名称 类型 示例值 描述
ErrCode String InternalError

调用出错时返回的错误码。
ErrMessage String The request processing has failed due to some unknown error.

调用错误时返回对应的错误信息。
RequestId String 2690E467-7773-43BC-A009-370EE2E7****

请求ID。
Success String true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=ConfigureSynchronizationJob
&DataInitialization=true
&StructureInitialization=true
&SynchronizationJobId=dtsz4ao1dor13d****
&SynchronizationObjects=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&<公共请求参数>

正常返回示例

XML格式 

<ConfigureSynchronizationJobResponse>
      <RequestId>2690E467-7773-43BC-A009-370EE2E7****</RequestId>
      <Success>true</Success>
</ConfigureSynchronizationJobResponse>

JSON格式 

{
	"RequestId": "2690E467-7773-43BC-A009-370EE2E7****",
	"Success": true
}

错误码

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