TIDB模块

SDK类名：/active/Tidb;

同步规则 - 新建

SDK 方法名：createTidbRule

URL

/tidb/rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
mysql_name	Boolean	否		@name
tgt_db_uuid	Array	否	备端数据库（分发时为多选）	D42BF707-C971-EEA9-521F-BB0F3F7A92FC
tgt_type	String	否	备库类型 mysql , oracle,kfaka,postgres,vertica,greenplum	oracle
start_rule_now	Number	否		0
dbmap_topic	String	否	kafka类型，整库映射
map_type	String	否	映射方式 库映射database 表映射：table 整库映射 all	table
tab_map	Array	否	表映射
src_table	String	否		src_table
dst_table	String	否		dst_table
src_db	String	否		111
dst_db	String	否		222
full_sync	Number	否	全量同步 当备端类型不是mysql时 全量同步不用选择同步方式 默认 否	0
incre_sync	Number	否	增量同步	1
model_type	String	否	模式 汇聚n:1, 分发:1:n，主-主:1:1 主-从:1:0	1:0
full_sync_mode	String	否	全同步方式，逻辑:logic 物理 physics 自动 auto（汇聚只有逻辑一种）	auto
db_set	Object	否	高级设置->数据库设置
binlog_row_image	String	否	full	full
default_storage_engine	String	否	innoDB	innoDB
sync_binlog	String	否	1	1
innodb_flush_log	String	否		2
innodb_flush_method	String	否	O_DIRECT	O_DIRECT
binlog_format	String	否	row	row
open_files_limit	String	否	65535	65535
server_id	String	否	随机值	123456
expire_logs_days	String	否	7	7
nat_mode	Number	否	否：0 是 1，默认为否，如果选择是，则显示出如下内容	0
ip	String	否	外网 ip
max_allowed_packet	String	否	52m	52
src_db_uuid	Array	否	汇聚可一次传多个已逗号隔开	1B1153F6-DAD9-BC39-888A-A743FCC208E5
primary_db_one	String	否	(主-主 有值其他情况空)主数据库1
primary_map_type_one	String	否	映射方式 库，表，整库 映射(主主 其他为空)
primary_map_one	String	否	主-主 有值其他情况空) 映射下传的值 {111:222, 111:333}
primary_db_two	String	否	主-主 有值其他情况空)主数据库2
primary_map_type_two	String	否	主-主 有值其他情况空)映射方式
primary_map_two	String	否	主-主 有值其他情况空)传递值
db_map	Array	否	库映射
dst_table	String	否
src_table	String	否
modify	Boolean	否		false
start_src_db_set	Number	否	开启源端配置	0
start_dst_db_set	Number	否		0
dst_db_set	Object	否	备端数据库设置
binlog_format	String	否
binlog_row_image	String	否
default_storage_engine	String	否
sync_binlog	String	否
innodb_flush_log	String	否
innodb_flush_method	String	否
max_allowed_packet	String	否
open_files_limit	String	否
server_id	String	否
expire_logs_days	String	否
nat_mode	Number	否
ip	String	否
dst_full_sync_set	Object	否
support_ddl	Number	否
change_tf_path	String	否
tf_file_save_time	String	否
nat_mode	String	否
foreign_ip	String	否
extraction	Number	否		0
start_lsn	Number	否
full_sync_set	Object	否	同步程序设置
support_ddl	Number	否	否:0 是 1，是否支持ddl 当备端为mysql时，缺省为支持DDL，当备端非mysql时，缺省为不支持DDL	1
change_tf_path	String	否	更改TF文件路径
tf_file_save_time	Number	否	传数字	7
nat_mode	Number	否	默认为否，如果选择是，则显示出如下内容	0
foreign_ip	String	否	外网ip
extraction	Number	否	是否支持远程抽取	0
start_lsn	Number	否
config	Object
dml_track	Object
delcol	String		删除标记字段名称
drp	Number		删除
enable	Number		0不启用 1启用	1
tmcol	String		操作时间字段名称
urp	Number		更新
src_connect_user	String
dst_connect_user	String
bw_settings	Object
bw_limit	String			"1200:00-13:0040M,300:00-13:0040M"
full_sync_settings	Object		全量设置
clean_user_before_dum	Number			0
concurrent_table	Array
dump_thd	Number
load_thd	Number
existing_table	String			drop_to_recycle
try_split_part_table	Number
etl_settings	Object
etl_table	Array
oprType	String			IRP
table	String
user	String
process	String			SKIP
addInfo	String
inc_sync_ddl_filter	Object
inc_sync_ddl_data	Array			[ "INDEX", "VIEW", "FUNCTION" ]
binary_code	String			hex
table_change_info	Number
jointing	Object		字段拼接
op	String		操作 op类型定义 前辍 prefix 后辍 append 常量 const 拼接 join 加 add 减 sub 乘 multiply 除 divide
table	String
content	String		目标列+其他两行
part_load_balance	String
kafka_time_out	String
save_json_text	Boolean		【目标类型为Kafka】保存为文件

Response

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

同步规则 - 修改

SDK方法名：modifyTidbRule

URL

/tidb/rule

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
mysql_name	String	否		mysql
src_db_uuid	Array	否		1B1153F6-DAD9-BC39-888A-A743FCC208E5
tgt_db_uuid	Array	否		D42BF707-C971-EEA9-521F-BB0F3F7A92FC
tgt_type	String	否		kafka
start_rule_now	Number	否		0
node_uuid	String	否		6B1153F6-DAD9-BC39-888A-A743FCC208E6
dbmap_topic	String	否
map_type	String	否		table
tab_map	Array	否
src_table	String	否		src_table
topic	String	否		topic
full_sync	Number	否		0
incre_sync	Number	否		1
model_type	String	否		1:0
full_sync_mode	String	否		auto
db_set	Object	否
db_node	String	否		1B1153F6-DAD9-BC39-888A-A743FCC208E5
binlog_format	String	否		row
binlog_row_image	String	否		full
default_storage_engine	String	否		innoDB
sync_binlog	String	否		1
innodb_flush_log	String	否		2
innodb_flush_method	String	否		O_DIRECT
max_allowed_packet	String	否		52
open_files_limit	String	否		65535
server_id	String	否		123456
expire_logs_days	String	否		7
nat_mode	Number	否		0
ip	String	否
full_sync_set	Object	否
support_ddl	Number	否		1
node	String	否		6B1153F6-DAD9-BC39-888A-A743FCC208E6
change_tf_path	String	否
tf_file_save_time	Number	否		7
nat_mode	Number	否		0
foreign_ip	String	否
primary_node_one	String	否
primary_node_two	String	否
primary_db_one	String	否
primary_map_type_one	String	否
primary_map_one	Array	否
primary_db_two	String	否
primary_map_type_two	String	否
primary_map_two	Array	否
db_map	Array	否
src_db	String	否		src_db
dst_db	String	否		dst_db
mysql_uuid	String	否		5349E2CF-7DBO-OAF2-13CB-BB7DFD8A9D86
config	Object
kafka_time_out	String
part_load_balance	String

Response

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

同步规则 - 删除

SDK方法名：deleteTidbRule

URL

/tidb/rule

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
mysql_uuids	Array	否
force	Boolean			true

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object
code	Number			0
message	String			[0] success
success_list	Array
code	Number			0
message	String			[0] success
mysql_uuid	String			16CB63E1-13FA-FB32-EB49-D790682C9648
mysql_name	String			task1
fail_list	Array
code	Number			-1
message	String			[-1] 找不到节点
mysql_uuid	String			16CB63E1-13FA-FB32-EB49-D790682C9647
mysql_name	String			task2

同步规则 - 获取单个

SDK方法名：describeTidbRule

URL

/tidb/rule/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
info_list	Object	否
mysql_name	String	否		mysql
src_db_uuid	String	否		['1111','2222']
tgt_db_uuid	Array	否		2222
tgt_type	String	否		kafka
start_rule_now	Number	否		0
node_uuid	String	否		6B1153F6-DAD9-BC39-888A-A743FCC208E6
dbmap_topic	String	否		db_topic
map_type	String	否	database	table
tab_map	Array	否			2
src_table	String	否		@name
dst_table	String	否		@name
src_db	String	否		111
dst_db	String	否		222
full_sync	Number	否		0
incre_sync	Number	否		1
model_type	String	否		n:1
full_sync_mode	String	否		auto
db_set	Object	否
db_node	String	否		1B1153F6-DAD9-BC39-888A-A743FCC208E5
binlog_format	String	否		row
binlog_row_image	String	否		full
default_storage_engine	String	否		innoDB
sync_binlog	String	否		777
innodb_flush_log	String	否		777
innodb_flush_method	String	否		O_DIRECT
max_allowed_packet	String	否		777
open_files_limit	String	否		777
server_id	String	否		777
expire_logs_days	String	否		777
nat_mode	Number	否		0
ip	String	否		192.168.1.1
full_sync_set	Object	否
support_ddl	Number	否		1
node	String	否		6B1153F6-DAD9-BC39-888A-A743FCC208E6
change_tf_path	String	否
tf_file_save_time	Number	否		777
nat_mode	Number	否		0
foreign_ip	String	否		192.168.1.1
start_lsn	String	否		9
primary_node_one	String	否		1111
primary_node_two	String	否		2222
primary_db_one	String	否		EC9D7dcC-55BC-849b-ABd1-F7AbADC7f936
primary_map_type_one	String	否		table
primary_map_one	String	否		{"123":"123"}
primary_db_two	String	否		b254e0c8-f91d-b4Ac-4ab3-C8A2bCbdB86c
primary_map_type_two	String	否		database
primary_map_two	String	否		{"44":"44","555":"555"}
db_map	Array	否			2
src_table	String	否		555
dst_table	String	否		666
dst_full_sync_set	Object	否
support_ddl	Number	否		1
change_tf_path	String	否
tf_file_save_time	Number	否		7
nat_mode	Number	否		0
foreign_ip	Number	否
extraction	Number	否		0
start_lsn	String	否		0
config	Object
dml_track	Object
enable	Number			0
urp	Number			0
drp	Number			0
tmcol	String
delcol	String

同步规则 - 操作

SDK方法名：

继续：resumeTidbRule;

停止：stopTidbRule;

修改：modifyTidbRule;

重启：restartTidbRule;

开始解析：startParsingTidbRule;

停止解析：stopParsingTidbRule;

重新解析：resetParsingTidbRule;

开始加载：startLoadTidbRule;

停止加载：stopLoadTidbRule;

重新加载：resetLoadTidbRule;

移除：removeTidbRule;

URL

/tidb/rule/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	resume 继续 stop 停止 restart 重启 modify start_parsing（开始解析） stop_parsing reset_parsing start_load（开始装载） stop_load reset_load remove | stop_schedule 停止调度 start_chedule 启动调度	restart
mysql_uuid	String	否		@guid
scn	String	否
tf	String	否	只有在重置装载时才有此值

Response

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

同步规则 - 列表

SDK方法名：listTidbRules

URL

/tidb/rule

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		1
limit	Number	否		10
search_field	String	否
search_value	String	否
where_args	Object	否
mysql_uuid	String	否		@guid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
total	Number	否		12
info_list	Array	否
mysql_uuid	Array	否	规则uuid	['3D7dFcd9-C176-d9ee-4FFB-f22bbd554929', '3D7dFcd9-C176-d9ee-4FFB-f22bbd554928']	+1
src_db_uuid	Array	否	源端uuid	['3D7dFcd9-C176-d9ee-4FFB-f22bbd554926']
tgt_db_uuid	Array	否	备端uuid	['3D7dFcd9-C176-d9ee-4FFB-f22bbd554927']
tgt_type	Array	否	备端类型	[ "kafka", "sqlserver", "hbase", "postgres", "oracle" ]	+1
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
mysql_name	String	否	规则名称	@name
tgt_db_name	Array	否	备端数据库名称	['bei']
model_type	String	否	n:1, 1:0	n:1
can_op	Number	否		1
can_up	Number	否		1
can_del	Number	否		1
src_db_name	Array	否	['111', 'hello']	['hello']
is_biz_admin	Number	否		1
map_type	String	否	table, database	database
tab_map	Array	否	表映射
src_table	String	否		@name
dst_table	String	否		@name
src_db	String	否		111
dst_db	String	否		222
db_map	Array	否	库映射
src_table	String	否		@name
dst_table	String	否		@name
message	String	否

同步规则-日志

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