全部产品
云市场
云游戏

配置同步作业

更新时间:2020-07-28 23:47:17

当调用购买同步作业接口购买完同步实例后,可以调用本接口配置同步作业。

只有当同步作业处于未配置状态时,才可以调用本接口配置作业。

调试

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

请求参数

参数名称 数据类型 是否必须 参数说明
Action String 系统默认参数,这个接口的接口定义,取值为:ConfigureSynchronizationJob
SynchronizationJobId String 同步作业Id
SynchronizationJobName String 同步作业名称
SynchronizationDirection String 这个参数只有当实例为双向同步时才会使用,指定同步方向,取值包括:Forward、Reverse,默认取值为Forward
SourceEndpoint.InstanceType String 同步链路的源端的实例类型,取值为:
Redis:阿里云Redis实例
RDS:阿里云RDS实例
POLARDB:阿里云PolarDB集群(仅支持MySQL或兼容Oracle语法的引擎)
ECS:ECS上的自建数据库
Express:通过专线接入的自建数据库
dg:通过数据库网关DG接入的自建数据库
cen:通过云企业网CEN接入的自建数据库
默认取值为RDS
SourceEndpoint.InstanceId String 同步源实例的实例ID
SourceEndpoint.IP String 源实例的连接地址。当SourceEndpoint.InstanceType取值为Express、dg或cen时,本参数必须传入
SourceEndpoint.Port String 源实例的监听端口,当SourceEndpoint.InstanceType取值为ECS、Express、dg或cen时,本参数必须传入。
SourceEndpoint.UserName String 源实例的访问账号,当SourceEndpoint.InstanceType取值为ECS、Express、dg或cen时,本参数必须传入。
源库为Redis时,本参数无需传入
SourceEndpoint.Password String 源实例的访问密码,当SourceEndpoint.InstanceType取值为ECS、Express、dg或cen时,本参数必须传入。
SourceEndpoint.OwnerID String 当同步源实例跟目标实例不属于同一个阿里云账号时,这个参数为源实例所属阿里云账号的UID
SourceEndpoint.Role String 当同步源实例跟目标实例不属于同一个阿里云账号时,这个参数为源实例所属账号对目标实例所属阿里云账号的授权角色,角色的相关权限及授权方法请参见跨账号迁移同步
DestinationEndpoint.InstanceType String 同步链路的目标端的实例类型,取值为:
Redis:阿里云Redis实例
RDS:阿里云RDS实例
POLARDB:阿里云PolarDB集群(仅支持MySQL或兼容Oracle语法的引擎)
ECS:ECS上的自建数据库
Express:通过专线接入的本地数据库
DataHub:阿里云DataHub实例
MaxCompute:阿里云MaxCompute实例
AnalyticDB:云原生数据仓库AnalyticDB MySQL 2.0版本(原分析型数据库MySQL版)
AnalyticDB30:阿里云分析型数据库MySQL 3.0版本
Greenplum:云原生数据仓库ADB PostgreSQL版(原分析型数据库PostgreSQL版)
默认取值为RDS
DestinationEndpoint.InstanceId String 同步目标实例的实例ID
当目标实例为MaxCompute或DataHub时,传入MaxCompute实例或DataHub的Project名称。
当目标实例为阿里云分析型数据库MySQL版时,传入分析型数据库MySQL版的集群ID。
DestinationEndpoint.IP String 目标实例连接地址,当DestinationEndpoint.InstanceType取值为Express、dg或cen时,本参数必须传入。
DestinationEndpoint.Port String 目标实例监听端口,当DestinationEndpoint.InstanceType取值为ECS、Express、dg或cen时,本参数必须传入。
DestinationEndpoint.UserName String 目标实例的访问账号,当DestinationEndpoint.InstanceType取值为ECS、Express、dg或cen时,本参数必须传入。
目标库为Redis时,本参数无需传入
DestinationEndpoint.Password String 目标实例的访问密码,当DestinationEndpoint.InstanceType取值为ECS、Express、dg或cen时,本参数必须传入。
SynchronizationObjects List 同步对象,格式为JSON串,详情请参见同步对象配置说明
StructureInitialization Boolean 同步之前是否进行结构对象初始化,取值包括:
true: 表示进行结构对象初始化
false:表示不进行结果对象初始化
默认取值为:true
DataInitialization Boolean 同步之前是否进行全量数据初始化,取值包括:
true: 表示进行全量数据初始化
false:表示不进行全量数据初始化
默认取值为:true
MigrationReserved String DTS预留参数,格式为JSON串,详情请参见MigrationReserved参数说明
例如在Redis企业版实例间的数据同步可使用该参数,详情请参见Redis企业版实例间单向或双向数据同步
OwnerId String 非服务化虚商接入时,指定资源的owner。

返回参数

参数名称 数据类型 参数说明
RequestId String 请求ID