数据库同步规则

SDK类名：/stream/SyncRule

同步规则 - 列表

SDK方法名：listSyncRules

URL

/vers/v3/sync_rule

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否	偏移数	1
limit	Number	否	最多多少行	10
search_field	String	否	搜索域	rule_name
search_value	String	否	搜索值
group_uuid	String	否	查询业务组
where_args	Object	否
rule_uuid	String	否		@guid
status	String		状态
src_db_name	String		数据源
tgt_db_name	String		目标端
db_ip	String		数据库ip
node_ip	String		机器节点ip
username	String		用户名
rule_name	String		（其余同步规则）规则名
src_db_type	String		源端数据库类型
tgt_db_type	String		备端数据库类型

Response

名称	类型	必选	简介	Mock初始值	Mock规则
total	Number	否		20
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
info_list	Array				10
username	String			admin
user_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String			['6ECF19A1-3754-1490-C6A3-52AFB4D7F497', '6ECF19A1-3754-1490-C6A3-52AFB4D7F496']
src_db_uuid	String			AF16E01E-6988-D0FA-3A7F-DEE04C4D3B4A
tgt_db_uuid	String			72855161-CD57-6FB5-C195-B19F466AB2C0
rule_type	Number			0
rule_name	String			123123
node_uuid	String
create_time	Number			1593511163
has_bk_takeover	String		是否有对应接管规则
has_reverse	String		是否有对应反向同步规则
bk_takeover_uuid	String		对应接管规则uuid
reverse_uuid	String		对应反向同步uuid
total	Number			11

同步规则 - 操作

SDK方法名：

继续：resumeOracleRule;

停止：stopOracleRule;

重启：restartOracleRule

开始日志解析：startAnalysisOracleRule;

停止日志解析：stopAnalysisOracleRule;

重新日志解析：resetAnalysisOracleRule;

停止规则并停止日志解析：stopAndStopanalysisOracleRule;

复制：duplicateOracleRule

URL

/vers/v3/sync_rule/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array	否	规则uuid	['@guid']	10
operate	String	否	resume 继续 stop 停止 restart 重启 start_analysis 启动解析 stop_analysis 停止解析 reset_analysis 重置解析 stop_and_stopanalysis 停止并停止解析 duplicate 复制 reverse_restart 重启反向同步 reverse_stop 停止反向同步 bk_takeover_restart 重新接管 bk_takeover_stop 停止接管 table_fix 表修复	restart
scn	String	否	（重置解析）SCN	1
all	Number		（重置解析）重置源库所有规则
rule_name	String		（复制）复制的规则新名称
tab	Array		（表修复）修复映射关系
user	String		用户
table	String		表名
fix_relation	Number		（表修复）是否修复关联表，0：关，1：开

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
data	Object
success_list	Array				5
code	Number			,0
message	String
rule_uuid	String
rule_name	Function			($x)=>{return JSON.stringify(arguments, null, 2);}
id	Number				+1
fail_list	Array				5
code	Number			-1
message	String
all_list	Array				10
code	Number			@pick(0,-1)
message	String

同步规则 - 新建

SDK方法名：createSyncRule; 创建同步规则

URL

/vers/v3/sync_rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_name	String		规则名称	ctt->ctt
comment	String		备注
src_db_uuid	String		源端数据库uuid	6C4AEF37-6496-6DCD-E085-DD640001E4EC
src_db_auth_uuid	String		源端用户认证uuid
tgt_db_uuid	String		备端数据库uuid	1C5F3C4B-7333-9518-7349-9712BC9ED664
tgt_db_auth_uuid	String		备端用户认证uuid
map_type_list	Array		映射方式（支持多种映射的规则使用，源端为Oracle或OceanBase）
base_settings	Object		基本设置
dbmap_topic	String		备端kafka整库映射topic
json_template	String		json模板
binary_code	String		二进制数据编码方式（hex、base64）
kafka_message_encoding	String		消息字符集（UTF-8、GBK）
kafka_time_out	Number		Producer超时时间（毫秒）
part_load_balance	String		分区均衡策略（by_table、by_key）
row_map_mode	String		行映射方式 （rowid、where、auto）
save_json_text	Boolean		保存为额外json
message_format	String		消息格式（protobuf、json）
full_sync_mode	String		全同步方式，逻辑:logic 物理 physics 自动 auto
lib_name	String		日志库名
jnr_name	String		日志名称
exclude_dbs	Array		排除库列表
exclude_dbs_switch	String		排除库开关，0：关，1：开
start_rule_now	String		立即开始规则，0：关，1：开
ob_sharding_inst	String		（源端为obshading）实例名
user_map	Object		用户映射模式
src_user	String			user1
tgt_user	String			user2
table_map	Array		表映射模式
key	Array		自定义主键key列	@last	3
split_dst_table	Array		表拆分
condition	String		拆分条件
dst_table	String		备端表名
dst_user	String		备端用户
dst_table	String		备端表名	a
dst_user	String		备端用户	b
src_table	String		源端表名	c
src_user	String		源端用户	d
column	Array
dst_column	String		备端字段	e
src_column	String		源端字段	f
column_map	Array		按列匹配映射,格式为：用户,列1，列2，列3。（用户支持星号）例： ["U1, ID, NAME", ", CARD"]
user	String		原用户
target	String		目标用户或目标topic（kafka）
column	String		列名
database_map	Array		pgsql整实例映射
src_database	String
src_schema	String
tgt_database	String
full_sync_settings	Object		全量设置
dump_thd	Number		全量导出线程数	1
load_thd	Number		全量装载线程数	1
clean_user_before_dump	Number		全量同步前清除用户	0
existing_table	String		并发同步表	drop_to_recycle
full_sync	Number		整库开关	0
start_scn	String		起始SCN
ld_dir_opt	Number			0
try_split_part_table	Number			0
concurrent_table	Array			["hello.world"]
full_sync_custom_cfg	Array		全局自定义配置
key	String
value	String
dump_split	Object		单表拆分配置
enable	Boolean		是否启用单表拆分	false
least_rows	Number		单表拆分最大行数
least_bytes	Number		单表拆分最大字节数
expire_seconds	Number		拆分过期时间（秒）
end_target_db	String		最终目标库
end_target_type	String		最终目标库类型
end_db_map	Array		最终库映射
src_db	String
tar_db	String
end_tab_map	Array		最终表映射
src_db	String
src_table	String
dst_db	String
dst_table	String
column	Array
src_column	String
dst_column	String
inc_sync_settings	Object		增量设置
incre_sync	Number		增量同步，0：关闭，1：开启
dyn_thread	Number		增量装载线程数
redo_read_thread	Number		读取日志线程数
ddl_cv	Number		备端对删除的表进行备份，0：关闭，1：开启
convert_urp_of_key	String		转换更新主键操作
sync_lob	Number		同步LOB数据，0：关闭，1：开启
keep_bad_act	Number		保留装载失败事务，0：关闭，1：开启
fill_lob_column	Number		补全更新操作LOB数据，0：关闭，1：开启
keep_seq_sync	String		序列校准
gen_txn	Number		定期在源库产生空事务，0：关闭，1：开启
merge_track	Number		统一解析，0：关闭，1：开启
storage_settings	Object		存储设置
src_max_mem	Number		源端内存缓存上限(MB)
src_max_disk	Number		源端磁盘缓存上限(MB)
txn_max_mem	Number		事务最大内存占用(KB)
tf_max_size	Number		最大跟踪文件大小(MB)
max_ld_mem	Number		增量装载队列内存上限(MB)
keep_incre_time	Number		备端保留增量导出数据时长
error_handling	Object		错误处理设置
load_err_set	String		装载错误处理方式 continue 继续装载 stopld:停止装载 stoptabld:停止此表装载
drp	String		删除时未找到记录 ignore :忽略 err:报错
irp	String		插入时记录冲突 "irpafterdel" （删除后插入，默认值） "tourp"（转换为更新） "err"（报错） 以上为原有值不变，新增以下三个值： "choose_bigger" （按指定字段更大值插入） "choose_smaller" （按指定字段更小值插入） "sp" （执行指定存储过程）
urp	String		更新时为找到记录 toirp: 转换为插入 err:报错
info	String		上传dml 错误，0：关闭，1：开启
report_failed_dml	String		指定信息，表示用户指定的字段名或者存储过程名称。
dml_track	Object		DML操作追踪设置
change_table_structure	Boolean		变更同步表结构
date_time_column_unique	String		操作产生时间字段值主键
load_date_time_column_unique	Boolean		操作装载时间字段值主键
op_column	String		操作标记字段名
opv_insert	String		操作标记字段：插入操作标记值
opv_update	String		操作标记字段：更新操作标记值
opv_update_key	String		操作标记字段：更新主键、唯一键操作标记值
opv_delete	String		操作标记字段：删除操作标记值
audit	Boolean		是否启用审计表
audit_prefix	String		审计表前辍
audit_appendix	String		审计表后辍
identity_column	String		自增列字段
load_date_column	String		操作装载时间字段名称仅日期
load_time_column	String		操作装载时间字段名称仅时间
load_date_time_column	Boolean		操作装载时间字段名称时间和日期
keep_deleted_row	Boolean		是否保留删除列 true
date_column	String		操作日期字段名
time_column	String		操作时间字段名
date_time_column	String		操作日期+时间字段名
trackmode	String		（DM）抽取方式，本地：local 远程：remote
incre_full_sync_custom_cfg	Array		（MySQL）增量自定义配置
key	String
value	String
full_sync_obj_filter	Object		全同步对象过滤
full_sync_obj_data	Array			["PROCEDURE","PACKAGE","PACKAGE BODY","DATABASE LINK","OLD JOB","JOB","PRIVS","CONSTRAINT","JAVA RESOURCE","JAVA SOURCE"]
inc_sync_ddl_filter	Object		增量同步对象ddl过滤
inc_sync_ddl_data	Array			["INDEX","VIEW","FUNCTION"]
other_settings	Object		其他设置
table_delay_load	Array		表延迟约束装载设置
keep_dyn_data	Number		（废弃字段）	0
dyn_thread	Number		增量装载线程数	1
dly_constraint_load	Number		（废弃字段）	0
ddl_cv	Number		备端对删除的表进行备份	0
keep_bad_act	Number		保留装载失败事务	0
keep_usr_pwd	Number		备库保留存在用户的密码	1
convert_urp_of_key	Number	是	转换更新主键操作	0
ignore_foreign_key	Number		忽略外键依赖	0
run_time	String		运行时间	"1200:00-13:0040M,300:00-13:0040M"
table_change_info	Number		表结构变更通知
jointing	Object		字段拼接
table	String		表
op	String		操作 op类型定义 前辍 prefix 后辍 append 常量 const 拼接 join 加 add 减 sub 乘 multiply 除 divide	append
content	Array		目标列+其他两行
enable_truncate_frequence	Number		truncate频率限制 0：关 1：开
tgt_extern_table	String		备端外部表存储位置
bw_limit	String		宽带设置
etl_table	Array		etl设置
oprType	String
table	String
user	String
process	String
addInfo	String
filter_table_settings	Object		表过滤设置
exclude_table	Array		表过滤设置
user	String		用户名
table	String		表名
exclude_tab_with_column	String		格式为：用户,列1，列2，列3。（用户支持星号）例： ["U1, ID, NAME", ", CARD"]
exclude_tab_with_column_switch	Number		按列匹配过滤表，0：关闭，1：开启
table_space_map	Object		表空间设置
tgt_table_space	String		备端表空间存储位置
table_mapping_way	String
table_path_map	Object		{"ddd":"sss","ddd1":"sss1"}
table_space_name	Object		{"qq":"ss"}
biz_grp_list	Array		业务组
compress_encrypt_settings	Object		压缩加密设置
compress_switch	String		压缩开关0：关，1：开
compress_level	String		压缩等级 1-9（算法为snappy固定为0，为lzma时可以选1-22）
compress_algo	String		压缩算法：lz4，zip，bzip2，snappy，zstd，lzma
encrypt_switch	String		加密开关0：关，1：开
encrypt	String		加密算法
compress	String		压缩级别 1 2 3 4 5 6 7 8 9 0（0为自定义压缩）
policy_settings	Object		运行策略（暂时不用）
policy_type	String
one_time	String
policies	String
maintenance	Number		维护模式，0：关，1：开
is_duplicate	Number		是否被复制规则，0：关，1：开
full_map_switch	Number		是否整库映射，0：关，1：开

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
uuid	String			@uuid
code	Number			0
message	String			success

同步规则 - 批量新建

SDK方法名：createBatchSyncRule;

URL

/vers/v3/sync_rule/batch

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
prefix	String		前缀
db_list	Array
rule_uuid	String
src_db_uuid	String
src_auth_db_uuid	String
tgt_db_uuid	String
tgt_auth_db_uuid	String
comment	String		备注
start_rule_now	Number		开始规则	0
map_type_list	Array		映射方式
user_map	Object		用户映射模式	{"CTT":"CTT"}
table_map	Array		表映射模式
key	Array		自定义主键key列	@last	3
split_dst_table	Array
condition	String		拆分条件
dst_table	String		备端表名
dst_user	String		备端用户
dst_table	String		备端表名	a
dst_user	String		备端用户	b
src_table	String		源端表名	c
src_user	String		源端用户	d
column	Array
dst_column	String		备端字段	e
src_column	String		源端字段	f
column_map	Object		按列匹配设置
include_tab_with_column	Array		格式为：用户,列1，列2，列3。（用户支持星号）例： ["U1, ID, NAME", ", CARD"]
user	String		原用户
target	String		目标用户或目标topic（kafka）
column	String		列名
include_tab_with_column_switch	String		按列匹配，0：关闭，1：开启
base_settings	Object		基本设置
dbmap_topic	String		备端kafka整库映射topic
json_template	String		json模板
binary_code	String		二进制数据编码方式（hex、base64）
kafka_message_encoding	String		消息字符集（UTF-8、GBK）
kafka_time_out	Number		Producer超时时间（毫秒）
part_load_balance	String		分区均衡策略（by_table、by_key）
row_map_mode	String		行映射方式 （rowid、where、auto）
save_json_text	Boolean		保存为额外json
message_format	String		消息格式（protobuf、json）
full_sync_settings	Object		全同步设置
dump_thd	Number			1
clean_user_before_dump	Number			0
existing_table	String			drop_to_recycle
sync_mode	Number			0
start_scn	String
keep_exist_table	Number			0
keep_table	Number			0
load_thd	Number			1
ld_dir_opt	Number			0
his_thread	Number			1
try_split_part_table	Number			0
concurrent_table	Array			["hello.world"]
full_sync_custom_cfg	Array		全局自定义配置
key	String
value	String
filter_table_settings	Object		表过滤设置
exclude_table	Array		表过滤设置
user	String		用户名
table	String		表名
exclude_tab_with_column	Array		格式为：用户,列1，列2，列3。（用户支持星号）例： ["U1, ID, NAME", ", CARD"]
exclude_tab_with_column_switch	Number		0：关闭，1：开启
incre_sync_settings	Object		增量设置
incre_sync	Number		增量同步
dyn_thread	Number		增量装载线程数
convert_urp_of_key	Number		转换更新主键操作
sync_lob	Number		同步LOB数据
gen_txn	Number		定期在源库产生空事务
merge_track	Number		统一解析
keep_bad_act	Number		保留装载失败事务
full_sync_obj_filter	Object		全同步对象过滤
full_sync_obj_data	Array			["PROCEDURE","PACKAGE","PACKAGE BODY","DATABASE LINK","OLD JOB","JOB","PRIVS","CONSTRAINT","JAVA RESOURCE","JAVA SOURCE"]
inc_sync_ddl_filter	Object		增量同步对象ddl过滤
inc_sync_ddl_data	Array			["INDEX","VIEW","FUNCTION"]
etl_settings	Object		etl设置
etl_table	Array
oprType	String			IRP
table	String
user	String
process	String			SKIP
addInfo	String
other_settings	Object		其他设置
gen_txn	String
table_delay_load	Array		["hh.ww"]
keep_dyn_data	Number			0
dyn_thread	Number			1
dly_constraint_load	Number			0
zip_level	Number			0
ddl_cv	Number		备端对删除的表进行备份	0
keep_bad_act	Number			0
keep_usr_pwd	Number			1
convert_urp_of_key	Number			0
ignore_foreign_key	Number			0
run_time	String		运行时间	"1200:00-13:0040M,300:00-13:0040M"
table_change_info	Number		表结构变更通知
jointing	Object		字段拼接
table	String		表
op	String		操作 op类型定义 前辍 prefix 后辍 append 常量 const 拼接 join 加 add 减 sub 乘 multiply 除 divide	append
content	Array		目标列+其他两行
encrypt_switch	Number
encrypt_type	Number
enable_truncate_frequence	Number		truncate频率限制 0：关 1：开
merge_track	String		统一解析
message_format	String		protobuf json
json_format	String		json canaljson message_format为json时，可传json ， canaljson， 其他值传空串
fill_lob_column	String
keep_seq_sync	String
storage_settings	Object		存储设置
keep_incre_time	String		备端保留增量导出数据时长
src_max_mem	Number		源端内存缓存上限	512
src_max_disk	Number		源端磁盘缓存上限	5000
txn_max_mem	Number		事务最大内存占用	10000
tf_max_size	Number		最大跟踪文件大小	100
tgt_extern_table	String
max_ld_mem	String
table_space_map	Object		表空间映射
tgt_table_space	String		备端表空间存储位置
table_mapping_way	String			ptop
table_path_map	Object			{"ddd":"sss","ddd1":"sss1"}
table_space_name	Object			{"qq":"ss"}
bw_settings	Object		宽带设置
bw_limit	String			"1200:00-13:0040M,300:00-13:0040M"
biz_grp_list	Array		业务组
error_handling	Object		错误处理
load_err_set	String		装载错误处理方式 continue 继续装载 stopld:停止装载 stoptabld:停止此表装载	continue
drp	String		删除时未找到记录 ignore :忽略 err:报错	ignore
irp	String		插入时记录冲突 "irpafterdel" （删除后插入，默认值） "tourp"（转换为更新） "err"（报错） 以上为原有值不变，新增以下三个值： "choose_bigger" （按指定字段更大值插入） "choose_smaller" （按指定字段更小值插入） "sp" （执行指定存储过程）	irpafterdel
urp	String		更新时为找到记录 toirp: 转换为插入 err:报错	toirp
report_failed_dml	Number		上传dml 错误 0：没选中 1：选中
info	String		任意字符串，表示用户指定的字段名或者存储过程名称。
dml_track	Array		DML操作追踪设置
change_table_structure	Boolean		变更同步表结构
date_time_column_unique	Boolean		操作产生时间字段值主键
load_date_time_column_unique	Boolean		操作装载时间字段值主键
op_column	String		操作标记字段名
opv_insert	String		操作标记字段：插入操作标记值
opv_update	String		操作标记字段：更新操作标记值
opv_update_key	String		操作标记字段：更新主键、唯一键操作标记值
opv_delete	String		操作标记字段：删除操作标记值
audit	Boolean		是否启用审计表
audit_prefix	String		审计表前辍
audit_appendix	String		审计表后辍
identity_column	String		自增列字段	AUTO_INCR
load_date_column	String		装载仅日期
load_time_column	String		装载仅时间
load_date_time_column	String		时间和日期
enable	Boolean		是否启用 true
keep_deleted_row	Boolean		是否保留删除列 true
date_column	String		操作日期字段名
time_column	String		操作时间字段名
date_time_column	String		操作日期+时间字段名
compress_encrypt_settings	Object		压缩加密设置
compress_switch	String		压缩开关0：关，1：开
compress_level	String		压缩等级 1-9（算法为snappy固定为0，为lzma时可以选1-22）
compress_algo	String		压缩算法：lz4，zip，bzip2，snappy，zstd，lzma
encrypt_switch	String		加密开关0：关，1：开
encrypt	String		加密算法
compress	String		压缩级别 1 2 3 4 5 6 7 8 9 0（0为自定义压缩）

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
uuid	String			@uuid
code	Number			0
message	String			success

同步规则 - 批量修改

SDK方法名：batchModifySyncRule; 批量修改同步规则

URL

/vers/v3/sync_rule/batch

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array		规则uuid数组
batch_base_settings	String		批量修改基本设置开关（包含映射部分） 0：关，1：开
batch_full_sync_settings	String		批量修改全量设置开关 0：关，1：开
batch_inc_sync_settings	String		批量修改增量设置开关 0：关，1：开
batch_full_sync_obj_filter	String		批量修改全量对象过滤设置开关 0：关，1：开
batch_inc_sync_ddl_filter	String		批量修改增量DDL过滤设置设置开关 0：关，1：开
batch_other_settings	String		批量修改高级设置设置开关 0：关，1：开
batch_compress_encrypt_settings	String		批量修改压缩加设置设置开关 0：关，1：开
map_type_list	Array		映射方式
base_settings	Object		基本设置
dbmap_topic	String		备端kafka整库映射topic
json_template	String		json模板
binary_code	String		二进制数据编码方式（hex、base64）
kafka_message_encoding	String		消息字符集（UTF-8、GBK）
kafka_time_out	Number		Producer超时时间（毫秒）
part_load_balance	String		分区均衡策略（by_table、by_key）
row_map_mode	String		行映射方式 （rowid、where、auto）
save_json_text	Boolean		保存为额外json
message_format	String		消息格式（protobuf、json）
full_sync_mode	String		全同步方式，逻辑:logic 物理 physics 自动 auto
lib_name	String		日志库名
jnr_name	String		日志名称
exclude_dbs	Array		排除库列表
exclude_dbs_switch	String		排除库开关，0：关，1：开
start_rule_now	String		立即开始规则，0：关，1：开
user_map	Object		用户映射模式
src_user	String			user1
tgt_user	String			user2
table_map	Array		表映射模式
key	Array		自定义主键key列	@last	3
split_dst_table	Array		表拆分
condition	String		拆分条件
dst_table	String		备端表名
dst_user	String		备端用户
dst_table	String		备端表名	a
dst_user	String		备端用户	b
src_table	String		源端表名	c
src_user	String		源端用户	d
column	Array
dst_column	String		备端字段	e
src_column	String		源端字段	f
column_map	Object		按列匹配映射,格式为：用户,列1，列2，列3。（用户支持星号）例： ["U1, ID, NAME", ", CARD"]
user	String		原用户
target	String		目标用户或目标topic（kafka）
column	String		列名
full_sync_settings	Object		全量设置
dump_thd	Number			1
clean_user_before_dump	Number			0
existing_table	String			drop_to_recycle
full_sync	Number		整库开关	0
start_scn	String
keep_exist_table	Number			0
keep_table	Number			0
load_thd	Number			1
ld_dir_opt	Number			0
try_split_part_table	Number			0
concurrent_table	Array			["hello.world"]
full_sync_custom_cfg	Array		全局自定义配置
key	String
value	String
inc_sync_settings	Object		增量设置
incre_sync	Number		增量同步，0：关闭，1：开启
dyn_thread	Number		增量装载线程数
ddl_cv	Number		备端对删除的表进行备份，0：关闭，1：开启
convert_urp_of_key	String		转换更新主键操作
sync_lob	Number		同步LOB数据，0：关闭，1：开启
keep_bad_act	Number		保留装载失败事务，0：关闭，1：开启
fill_lob_column	Number		补全更新操作LOB数据，0：关闭，1：开启
keep_seq_sync	String		序列校准
gen_txn	Number		定期在源库产生空事务，0：关闭，1：开启
merge_track	Number		统一解析，0：关闭，1：开启
storage_settings	Object		存储设置
src_max_mem	Number		源端内存缓存上限(MB)
src_max_disk	Number		源端磁盘缓存上限(MB)
txn_max_mem	Number		事务最大内存占用(KB)
tf_max_size	Number		最大跟踪文件大小(MB)
max_ld_mem	Number		增量装载队列内存上限(MB)
keep_incre_time	Number		备端保留增量导出数据时长
error_handling	Object		错误处理设置
load_err_set	String		装载错误处理方式 continue 继续装载 stopld:停止装载 stoptabld:停止此表装载
drp	String		删除时未找到记录 ignore :忽略 err:报错
irp	String		插入时记录冲突 "irpafterdel" （删除后插入，默认值） "tourp"（转换为更新） "err"（报错） 以上为原有值不变，新增以下三个值： "choose_bigger" （按指定字段更大值插入） "choose_smaller" （按指定字段更小值插入） "sp" （执行指定存储过程）
urp	String		更新时为找到记录 toirp: 转换为插入 err:报错
info	String		上传dml 错误，0：关闭，1：开启
report_failed_dml	String		指定信息，表示用户指定的字段名或者存储过程名称。
dml_track	Object		DML操作追踪设置
change_table_structure	Boolean		变更同步表结构
date_time_column_unique	String		操作产生时间字段值主键
load_date_time_column_unique	Boolean		操作装载时间字段值主键
op_column	String		操作标记字段名
opv_insert	String		操作标记字段：插入操作标记值
opv_update	String		操作标记字段：更新操作标记值
opv_update_key	String		操作标记字段：更新主键、唯一键操作标记值
opv_delete	String		操作标记字段：删除操作标记值
audit	Boolean		是否启用审计表
audit_prefix	String		审计表前辍
audit_appendix	String		审计表后辍
identity_column	String		自增列字段
load_date_column	String		操作装载时间字段名称仅日期
load_time_column	String		操作装载时间字段名称仅时间
load_date_time_column	Boolean		操作装载时间字段名称时间和日期
keep_deleted_row	Boolean		是否保留删除列 true
date_column	String		操作日期字段名
time_column	String		操作时间字段名
date_time_column	String		操作日期+时间字段名
full_sync_obj_filter	Object		全同步对象过滤
full_sync_obj_data	Array			["PROCEDURE","PACKAGE","PACKAGE BODY","DATABASE LINK","OLD JOB","JOB","PRIVS","CONSTRAINT","JAVA RESOURCE","JAVA SOURCE"]
inc_sync_ddl_filter	Object		增量同步对象ddl过滤
inc_sync_ddl_data	Array			["INDEX","VIEW","FUNCTION"]
other_settings	Object		其他设置
table_delay_load	Array		表延迟约束装载设置
keep_dyn_data	Number			0
dyn_thread	Number			1
dly_constraint_load	Number			0
zip_level	Number			0
ddl_cv	Number		备端对删除的表进行备份	0
keep_bad_act	Number			0
keep_usr_pwd	Number		备库保留存在用户的密码	1
convert_urp_of_key	Number	是		0
ignore_foreign_key	Number		忽略外键依赖	0
run_time	String		运行时间	"1200:00-13:0040M,300:00-13:0040M"
table_change_info	Number		表结构变更通知
jointing	Object		字段拼接
table	String		表
op	String		操作 op类型定义 前辍 prefix 后辍 append 常量 const 拼接 join 加 add 减 sub 乘 multiply 除 divide	append
content	Array		目标列+其他两行
enable_truncate_frequence	Number		truncate频率限制 0：关 1：开
tgt_extern_table	String		备端外部表存储位置
bw_limit	String		宽带设置
etl_table	Array		etl设置
oprType	String
table	String
user	String
process	String
addInfo	String
filter_table_settings	Object		表过滤设置
exclude_table	Array		表过滤设置
user	String		用户名
table	String		表名
exclude_tab_with_column	String		格式为：用户,列1，列2，列3。（用户支持星号）例： ["U1, ID, NAME", ", CARD"]
exclude_tab_with_column_switch	Number		按列匹配过滤表，0：关闭，1：开启
table_space_map	Object		表空间设置
tgt_table_space	String		备端表空间存储位置
table_mapping_way	String
table_path_map	Object		{"ddd":"sss","ddd1":"sss1"}
table_space_name	Object		{"qq":"ss"}
biz_grp_list	Array		业务组
compress_encrypt_settings	Object		压缩加密设置
compress_switch	String		压缩开关0：关，1：开
compress_level	String		压缩等级 1-9（算法为snappy固定为0，为lzma时可以选1-22）
compress_algo	String		压缩算法：lz4，zip，bzip2，snappy，zstd，lzma
encrypt_switch	String		加密开关0：关，1：开
encrypt	String		加密算法
compress	String		压缩级别 1 2 3 4 5 6 7 8 9 0（0为自定义压缩）
policy_settings	Object		运行策略
policy_type	String
one_time	String
policies	String
maintenance	Number		维护模式，0：关，1：开
is_duplicate	Number		是否被复制规则，0：关，1：开
full_map_switch	Number		是否整库映射，0：关，1：开

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
uuid	String			@uuid
code	Number			0
message	String			success

同步规则 - 删除

SDK方法名：deleteSyncRule

URL

/vers/v3/sync_rule

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuids	Array		规则数组
force	Boolean		强制删除

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
data	Object	否
code	Number	否		1
message	String	否		Delete success
success_list	Array
code	String			0
rule_uuid	String			@guid
rule_name	String			@first
message	String
fail_list	Array
code	Number			-1
message	String
rule_uuid	String			@guid
rule_name	String			@first
ret	Number	否		200

同步规则 - 通用操作

SDK方法名：syncRuleCommonOperate;

URL

/vers/v3/sync_rule/common_operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String		resume 继续 stop 停止 restart 重启
uuids	Array		操作对应规则uuid	@guid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
data	Object
success_list	Array				5
code	Number			,0
message	String
fail_list	Array				5
code	Number			-1
message	String
all_list	Array				10
code	Number			@pick(0,-1)
message	String

同步规则-获取单个

SDK方法名：describeSyncRules

URL

/vers/v3/sync_rule/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String	否		F530FB0E-0208-9071-66D3-E595AE7D5A4C

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否		success
code	Number	否		0
info_list	Object	否
rule_uuid	String	否		751A03F5-C97D-645B-82B2-316A5D198528
src_db_uuid	String	否		4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuid	String	否		40405FD3-DB86-DC8A-81C9-C137B6FDECE5
tgt_type	String	否		kafka
db_user_map	String	否		{"11":"1122"}
row_map_mode	String	否		rowid
map_type	String	否		user
table_map	Array	否		[{src_user: "111", src_table: "222", dst_user: "3", dst_table: "4"}]
dbmap_topic	String	否
node_uuid	String	否
sync_mode	Number	否		0
start_scn	String	否		0
full_sync_settings	Object	否
keep_exist_table	Number	否		0
keep_table	Number	否		0
load_mode	String	否		direct
ld_dir_opt	Number	否		0
his_thread	Number	否		1
try_split_part_table	Number	否		0
concurrent_table	Array	否		["hello.world"]
rule_name	String	否		ctt->ctt
inc_sync_ddl_filter	Object	否
inc_sync_ddl_data	Array	否		["CREATE TABLE","DROP TABLE","ALTER TABLE"]
filter_table_settings	Object	否
exclude_table	Array	否		["hh.ww"]
etl_settings	Object	否
etl_table	Array	否		[{obj_fix_type: "URP", user: "123", table: "123", deal_type: "SKIP", field_condition: "44"}]
start_rule_now	Number	否		0
storage_settings	Object	否
src_max_mem	Number	否		512
src_max_disk	Number	否		5000
txn_max_mem	Number	否		10000
tf_max_size	Number	否		100
tgt_extern_table	String	否
error_handling	Object	否
load_err_set	String	否		continue
drp	String	否		ignore
irp	String	否		irpafterdel
urp	String	否		toirp
table_space_map	Object	否
tgt_table_space	String	否
table_mapping_way	String	否		ptop
table_path_map	String	否		{"ddd":"sss"}
table_space_name	String	否		{"qq":"ss"}
other_settings	Object	否
keep_dyn_data	Number	否		0
dyn_thread	Number	否		1
dly_constraint_load	Number	否		0
zip_level	Number	否		0
ddl_cv	Number	否		0
keep_bad_act	Number	否		0
keep_usr_pwd	Number	否		1
convert_urp_of_key	Number	否		0
ignore_foreign_key	Number	否		0
bw_settings	Object	否
bw_limit	String	否		1200:00-13:0040k,300:00-13:0040m
biz_grp_list	Array	否	业务组
dml_track	Object	否
enable	Number	否		1
urp	Number	否		0
drp	Number	否		1
tmcol	String	否
delcol	String	否
producer_send_time	String	否		66666
part_load_balance	String	否		by_table
kafka_time_out	String	否		132000
full_sync_obj_filter	Object	否
full_sync_obj_data	Array	否		["PROCEDURE","PACKAGE","PACKAGE BODY","DATABASE LINK","OLD JOB","JOB","PRIVS","CONSTRAINT","JAVA RESOURCE","JAVA SOURCE"]

同步规则-状态

SDK方法名：listSyncRulesStatus

URL

/vers/v3/sync_rule/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
has_false_rule	Boolean		是否有残留规则	false
info_list	Array				2
rule_uuid	String		同步规则 uuid	['6ECF19A1-3754-1490-C6A3-52AFB4D7F497', '6ECF19A1-3754-1490-C6A3-52AFB4D7F496']	+1
work_state	Object		导出状态信息
status	String		ACTIVE_RULE_NORMAL : 正常 ACTIVE_RULE_ABNORMAL : 异常 ACTIVE_RULE_TRACK : 增量 ACTIVE_RULE_TRACK_WARNING : 增量 ACTIVE_RULE_PAUSE : 停止 ACTIVE_RULE_STOP : 停止 ACTIVE_RULE_DUMPDICT : 准备 ACTIVE_RULE_DUMP : 全量 ACTIVE_RULE_DONE : 完成 ACTIVE_RULE_FINISH : 完成 ACTIVE_RULE_ERROR : 错误 ACTIVE_RULE_INIT : 未启动 ACTIVE_RULE_FIX : 修复中 ACTIVE_RULE_UNKNOWN : 未知 ACTIVE_RULE_ONLINE : 在线 ACTIVE_RULE_WARN : 警告 ACTIVE_RULE_DOING : 在线 ACTIVE_RULE_ : 未知 ACTIVE_RULE_OFFLINE : 停止 ACTIVE_RULE_RUN : 运行 ACTIVE_RULE_WAIT : 准备 ACTIVE_REVERSE_FINISH : 完成 ACTIVE_REVERSE_ABNORMAL : 异常 ACTIVE_REVERSE_WARN : 警告 ACTIVE_REVERSE_UNKNOWN : 未知 ACTIVE_REVERSE_ : 未知 ACTIVE_REVERSE_FINISH : 完成 ACTIVE_REVERSE_ABNORMAL : 异常 ACTIVE_REVERSE_WARN : 警告 ACTIVE_REVERSE_UNKNOWN : 未知 ACTIVE_REVERSE_ : 未知 REVERSE_DOING : 在线 REVERSE_DONE : 完成 REVERSE_STOP : 停止 REVERSE_PAUSE : 暂停 ACTIVE_RULE_SCHEDULING : [调度中] ACTIVE_RULE_STOP_SCHEDUL : [停止调度] OBJ_FIX_DOING : 正在修复 OBJ_FIX_DONE : 修复完成 OBJ_FIX_ERROR : 修复错误 OBJ_FIX_UNKNOWN : 未知 OBJ_FIX_STOP : 停止修复 OBJ_FIX_ABNORMAL : 修复异常 OBJ_FIX_PAUSE : 停止 OBJ_FIX_OFFLINE : 离线 CMP_ABNORMAL : 比较异常 CMP_DOING : 正在比较 CMP_DONE : 比较完成 CMP_ERROR : 比较错误 CMP_UNKNOWN : 未知 CMP_PAUSE : 停止 CMP_STOP : 停止 CMP_WAIT : 等待中 CMP_OFFLINE : 离线 TAKEOVER_UNKNOWN : 未知 TAKEOVER_DOING : 正在接管 TAKEOVER_DONE : 接管完成 TAKEOVER_ERROR : 接管错误 TAKEOVER_STOP : 接管停止 TAKEOVER_ABNORMAL : 接管异常 TAKEOVER_OFFLINE : 离线	ACTIVE_RULE_TRACK
error_code	Number			-4018
progress	String			[98, 66]	+1
back_state	Object		装载信息
status	String		同上work_state	ACTIVE_RULE_PAUSE
relay_state	Object		中继节点的信息
status	String		同上work_state
error_code	String
track_state	Object		解析状态信息
status	String		同上work_state	['ACTIVE_RULE_PAUSE', 'OFFLINE']	+1
src_state	Object		此功能对应数据源的状态，领导要求暂时屏蔽此功能，可不看
status	String			ACTIVE_RULE_UNKNOWN
dst_state	Object		同src_state
status	String			ACTIVE_RULE_UNKNOWN
extract	String		解析时间	-
load	String		装载时间	-
delay	Number		延迟	0
peak	Number		峰值	0
has_new_err	Number		对应日志报警 1：显示有新的日志 0：没有新日志产生	1
data_info	Object		对应的悬浮框内的信息
dst	Object		目标端
db_ip	Array		目标端ip	["192.168.12.199"]
node_ip	String		节点ip	192.168.12.199
node_name	String		名称	test_c199
log_read_type	String		日志读取方式	file
orcl	String		服务名	orcl
src	Object		数据源
db_ip	Array		数据库ip	["192.168.12.200"]
node_ip	String		节点ip	192.168.12.200
node_name	String		节点名	test_c200
log_read_type	String		读取方式	file
orcl	String		服务名	orcl
stage	String		对应原先功能总览->同步规则的功能，暂时弃用	PAUSE
state	Number		对应原先功能总览->同步规则的功能，暂时弃用	-4018
progress	Null		对应原先功能总览->同步规则的功能，暂时弃用
scheduleState	String		ACTIVE_RULE_SCHEDULING：调度中 ACTIVE_RULE_STOP_SCHEDUL:停止调度	ACTIVE_RULE_STOP_SCHEDUL

同步规则 - 分片信息

SDK方法名：listSyncRulesSliceStatus

URL

/vers/v3/sync_rule/slice_status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String		规则uuid
page	Number	否	偏移数	1
limit	Number	否	最多多少行	10
search_field	String	否	搜索域	rule_name
search_value	String	否	搜索值
where_args	Object	否
src_slice_id	String	否	源端分片ID	@id
src_slice_ip	String		源端分片IP	@ip
src_slice_port	String		源端端口
src_slice_status	String		源端分片状态
status	String		状态

Response

名称	类型	必选	简介	Mock初始值	Mock规则
total	Number	否		20
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
status	Array				10
rule_uuid	String		uuid	[6ECF19A1-3754-1490-C6A3-52AFB4D7F497
src_slice_id	String		源端分片ID	shard-01
src_slice_addr	Array		源端分片状态	1.1.1.1
slice_ip	String		源端分片IP
slice_port	String		源端分片端口
slice_status	String		源端分片状态，主：master，从：slave
work_state	Object		导出状态
status	String		状态
error_code	Number		错误码（有错误码时优先显示错误码）
back_state	Object		装载状态
status	String
error_code	Number
track_state	Object		解析状态
status	String
error_code	Number
extract	String		解析时间	2024-05-29 17:01:24
load	String		装载时间	2024-05-29 17:01:24
delay	String		延迟	10
peak	String		峰值	10
cluster_name	String		集群名
manage_name	String		租户名
phy_addr	String		物理地址
phy_port	String		物理端口
total	Number			11

同步规则-日志（复用旧接口）

SDK方法名：listRuleLog;同规则的日志管理

URL

/active/rule/log

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
offset	Number	否		0
limit	Number	否		10
date_start	String	否	开始时间	@date
date_end	String	否	开始时间的结束时间	@date
type	Number	否	0：错误 2:消息 -1:全部	-1
module_type	Number	否	0:导出 1:装载 2:解析 3:中继 4:脱敏 -1 全部	-1
query_type	Number	否	最新查询：1 最早查询：2 查询 :0	1
rule_uuid	String	否	规则uuid	F530FB0E-0208-9071-66D3-E595AE7D5A4C
search_content	String		关键词过滤	test

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		Delete success
info_list	Array	否			5
create_time	String	否		2019-08-09 17:29:43
detail	String	否		Full Sync done, elapsed time: 24 sec'
log_level	String	否	日志级别 0:serious 2	2
flag	Number	否	0:正常， 1新信息 标红	1
log_type	String	否	模块： 导出，装载，解析	装载
uuid	String	否		@uuid
total	Number	否		666
ret	Number			200

同步规则 - 修改维护模式

SDK方法名：switchSyncRuleMaintenance

URL

/vers/v3/sync_rule/maintenance

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
maintenance_switch	String
uuid	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			0
msg	String
data	Object
code	Number
message	String

同步规则-选择用户

SDK方法名：describeRuleUser;选择用户

URL

/active/rule/select_user

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
db_uuid	String	否	数据uuid	@guid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		Delete success
info_list	Array	否			6
id	String	否
pid	String	否
db_uuid	String	否	db_uuid	@guid
name	String	否		@name
ret	Number	否		200

同步规则-表修复

SDK方法名：ruleTableFix;表修复

URL

/active/rule/table_fix

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String	否	规则uuid	F530FB0E-0208-9071-66D3-E595AE7D5A4C
tab	Array	否	I2.table	["I2.table"]
fix_relation	Number	否	0 无关联 1 有关联	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0

同步规则-获取scn号

SDK方法名：ruleGetScn;

URL

/active/rule/get_scn

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String	否		@guid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
scn	String	否

同步规则 - 从底层获取SCN

SDK方法名：ruleGetRpcScn;

URL

/active/rule/get_rpc_scn

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
db_uuid	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Object
message	String
code	Number
scn	String

同步规则 - 从底层获取接管SCN

SDK方法名：ruleGetReverseScn;

URL

/active/rule/get_revert_rpc_scn

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Object
message	String
code	Number
scn	String

同步规则-偏移量信息

SDK方法名：listKafkaOffsetInfo;

URL

/active/rule/kafka_offset

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String			@guid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
info_list	String
ret	Number			200
msg	String
data	Object
message	String
code	Number			0
info_list	Object
update_time	String			2020-12-02 18:07:59
kafka_latest_offset	Array				2
topic	String			test1
partition	String			0
offset	String			1
timestamp	String			2020-12-02 16:45:27

同步规则 - 全量状态统计

SDK方法名：getRuleFullSyncStat

URL

/vers/v3/sync_rule/full_sync_stat

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String
limit	String
offset	String
user	String
table	String
stage	String		状态过滤 total：所有 done：完成 sync：正在同步 err：同步失败 wait：等待同步	total

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
summary	Object
total	Number		总表数	10
wait	Number			2
sync	Number			3
done	Number			4
err	Number			5
stats	String		符合查询结果总表数（分页用）	2
tabst	Array
user	String		用户	u1
name	String		表名	t1
stage	String		状态	done
start	String		同步开始时间	2024-07-08 10:45:10
end	String		同步结束时间	2024-07-08 10:45:10
rows	Number		表总行数	123
drows	Number		已同步行数	123
bytes	Number		数据量（bytes）	123
dtime	Number		同步用时（s）	1
speed	Number		传输速率（row/s）	123
total	Number			10