SQL Server 同步

SDK类名：/active/Sqlserver

示例接口

示例接口描述

URL

/example/1589341125844

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
foo	String	否	请求属性示例	@ctitle

Response

名称	类型	必选	简介	Mock初始值	Mock规则
string	String	否	字符串属性示例	★	1-10
number	Number	否	数字属性示例	1	1-100
boolean	Boolean	否	布尔属性示例	true	1-2
regexp	RegExp	否	正则属性示例	/[a-z][A-Z][0-9]/
function	Function	否	函数属性示例	() => Math.random()
array	Array	否	数组属性示例		1-10
foo	Number	否	数组元素示例	1	+1
bar	String	否	数组元素示例	★	1-10
items	Array	否	自定义数组元素示例	[1, true, 'hello', /\w{10}/]
object	Object	否	对象属性示例
foo	Number	否	对象属性示例	1	+1
bar	String	否	对象属性示例	★	1-10
placeholder	String	否	占位符示例	@title

新建

SDK方法名：createRule

URL

/sqlserver/rule

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_name	String	否
src_db_uuid	String	否
tgt_db_uuid	String	否
tgt_type	String	否		sqlserver
map_type	String	否		db
config	Object	否
start_rule_now	Number	否		1
publish_sub_switch	Number		发布订阅开关，0：关，1：开
table_map	Array	否
src_table	String		源端表名
dst_table	String		备端表名
src_user	String		源端用户
dst_user	String		备端用户
column	Array
src_column	String		源端列名
dst_column	String		备端列名
enable_cdc	Number	否	源端开启cdc	0
enable_cdc_table	String		从CDC表读取数据 0：关，1：开
mirror_db_uuid	String	否
sync_mode	Number	否		1
dump_thd	Number	否		1
drop_old_tab	Number	否		1
lsn	String
etl_settings	Object
etl_table	Array
oprType	String
table	String
user	String
process	String
addInfo	String
loader	Number		tabloader
ip	String
datport	String		数据端口
db_user_map	Object
dst_connect_user	String		备端连接用户
src_connect_user	String		源端连接用户
bw_settings	Object
bw_limit	String			"1200:00-13:0040M,300:00-13:0040M"
inc_sync_ddl_data	Array		其它的和oracle 一致，多余的下发如下 [ 'ADD FILE GROUP', // 增加文件组 'DELETE FILE GROUP', //删除文件组 'ADD DATA FILE', // 增添数据文件 'DELETE DATA FILE',// 删除数据文件 ]
filter_table_settings	Object		过滤表设置
exclude_table	Array
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" ]
run_time	String		运行时间	"1200:00-13:0040M,300:00-13:0040M"
save_json_text	Boolean		【目标类型为：Kafka】增加“另存为文本”开关参数	false

Response

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

sqlser同步规则-增量失败DML统计

SDK方法名：describeSyncRulesDML

URL

/sqlserver/rule/incre_dml_summary

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
offset	Number	否	偏移位置	1
limit	String	否	搜索行数	10
usr	String	否	用户
rule_uuid	String	否	规则uuid	@guid
sort_order	String	否	排序方式	asc
search	String	否	搜索
sort	String	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
info_list	Array	否
usr	String	否		usr
table_name	String	否		table200
irp_error_number	Number	否		30
urp_error_number	Number	否		60
drp_error_number	Number	否		90
total	Number	否		1

--------- 同步规则---------

URL

/ 

Method

GET

Request

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

Response

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

sql规则-已同步的对象具体信息

SDK方法名：describeSyncRulesObjInfo

URL

/sqlserver/rule/sync_obj_info

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
offset	Number	否		0
limit	Number	否		10
rule_uuid	String	否		@guid
usr	String	否
sort	String	否
sort_order	String	否
search	String	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
info_list	Array	否			2
nAll	Number	否
eAll	Number	否
name	String	否		I2_1
nRow	String	否		112003
eIRP	String	否		0
eURP	String	否		0
eDRP	String	否		1
nIRP	String	否		1
nURP	String	否		1
nDRP	String	否		1
state	String	否		-
total	Number	否		2000

批量新建

SDK方法名：batchCreateRule

URL

/sqlserver/rule/batch_add

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tgt_type	String			sqlserver
map_type	String			db
config	Object
enable_cdc	Number			0
start_rule_now	Number			1
dump_thd	Number			1
sync_mode	Number			1
drop_old_tab	Number			1
table_map	String
etl_settings	Object
etl_table	Array
oprType	String
table	String
user	String
process	String
addInfo	String
rule_list	Array
rule_name	String
src_db_uuid	String
tgt_db_uuid	String
mirror_db_uuid	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
info_list	Array				2
code	Number			-3565
message	String			[-3565]IPC request is not recognized: I2.IPC_RULE_ADD
rule_name	Array			["123->sqlserver-1","123->sqlserver-2"]	+1

修改

SDK方法名：modifyRule

URL

/sqlserver/rule

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_name	String			test
src_db_uuid	String			7B1BE386-4CB1-86AA-D39D-B644C2EADD57
tgt_db_uuid	String			CD52E44B-D25A-4CE3-126F-6F5A460731E4
tgt_type	String			sqlserver
map_type	String			table
config	Object
etl_settings	Object
etl_table	Array
oprType	String
table	String
user	String
process	String
addInfo	String
loader	Number
ip	String
datport	String
db_user_map	Object
bw_settings	Object
bw_limit	String
run_time	String		运行时间	"1200:00-13:0040M,300:00-13:0040M"
start_rule_now	Number			1
table_map	String			[{"src_user":"1","src_table":"2","dst_user":"1","dst_table":"2","column":[]}]
enable_cdc	Number			0
mirror_db_uuid	String
sync_mode	Number			1
dump_thd	Number			1
drop_old_tab	Number			1

Response

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

删除

SDK方法名：deleteRule

URL

/sqlserver/rule

Method

DELETE

Request

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

Response

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

启停

SDK方法名：operateRule

URL

/sqlserver/rule/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String		resume | stop	start	stop_schedule 停止调度 start_schedule 启动调度
uuids	Array

Response

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

状态获取

SDK方法名：listRuleStatus

URL

/sqlserver/rule/status

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
info_list	Array				2
rule_uuid	Array			["6FBC9EB9-A10A-E226-9F2B-A77B3CF1D337","3BF809AF-4A2E-DD28-072E-530D33BAC189"]	+1
export_state	Object
status	String			ACTIVE_RULE_ABNORMAL
load_state	Object
status	String			ACTIVE_RULE_STOP
stage	String		pause: 停止 dump: 全量 track:增量 done:完成 offline:离线	dump
state	String		0:正常 非0：错误	0
progress	String		进度	80
track_state	Object
status	String			ACTIVE_RULE_TRACK

批量新建时重名检查

SDK方法名：checkName

URL

/sqlserver/rule/check_name

Method

POST

Request

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

Response

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

列表

SDK方法名：listRule

URL

/sqlserver/rule

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
total	Number			5
info_list	Array				2
rule_uuid	Array			["6FBC9EB9-A10A-E226-9F2B-A77B3CF1D337","3BF809AF-4A2E-DD28-072E-530D33BAC189"]	+1
rule_name	Array			["Ronald Lopez","Melissa Brown"]	+1
src_db_uuid	String
tgt_db_uuid	String
tgt_type	String			kafka
user_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
tgt_db_name	String			bei
map_type	String			database
config	Object
start_rule_now	Number			1
table_map	String
full_sync	Number			1
incre_sync	Number			1
full_sync_mode	String
db_user_map	Object
dbmap_topic	String
row_map_mode	String
kafka_time_out	String
part_load_balance	String
kafka_message_encoding	String
src_db_name	String			1111
is_biz_admin	Number			1
can_del	Number			1
can_op	Number			1
can_up	Number			1
rule_type	Number			40
message	String
code	Number			0

表比较 - 新建

SDK方法名：createTbCmp

URL

/sqlserver/tb_cmp

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tb_cmp_name	String	否		ctt->ctt
src_db_uuid	String	否		4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuid	String	否		40405FD3-DB86-DC8A-81C9-C137B6FDECE5
cmp_type	String	否		user,table,db
db_user_map	String	否		{"CTT":"CTT"}
filter_table	Array	否		[用户.表名]
db_tb_map	String	否		表映射
dump_thd	Number	否	抽取线程数
rule_uuid	String	否		@guid
polices	String	否	策略	"0|00:00
policy_type	String	否	策略类型;periodic(周期) ，one_time 一次性任务 immediate 立刻执行	one_time
concurrent_table	Array	否	并发表	["hh.ww"]
try_split_part_table	Number	否	尝试并发设置 0:否 1：是	0
one_time	String	否	策略的开始时间，如果不是一次性任务为空值	2019-05-27 16:07:08
repair	Number	否		0
fix_related	Number	否		0

Response

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

同步规则-日志

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

URL

/sqlserver/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

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方法名：describeListRule;

URL

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

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
rule_uuid	String			6FBC9EB9-A10A-E226-9F2B-A77B3CF1D337

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
message	String			success
code	Number			0
sqlserver_rule	Object
rule_name	String			test
src_db_uuid	String			7B1BE386-4CB1-86AA-D39D-B644C2EADD57
tgt_db_uuid	String			CD52E44B-D25A-4CE3-126F-6F5A460731E4
tgt_type	String			kafka
map_type	String			db
config	Object
table_map	String			'[{"src_user":"11","src_table":"22","dst_user":"11","dst_table":"22","column":[]}]'
dump_thd	Number			1
drop_old_tab	Number			1
enable_cdc	Number			0
tart_rule_now	Number			1
mirror_db_uuid	String
sync_mode	Number			1
etl_settings	Object
etl_table	Array
oprType	String
table	String			ddd
user	String			ddd
process	String
addInfo	String
db_user_map	Object
uuid	String			7B1BE386-4CB1-86AA-D39D-B644C2EADD44

表比较 - 获取单个

SDK方法名：describeTbCmp

URL

/sqlserver/tb_cmp/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
src_db_uuid	String	否		4CA773F4-36E3-A091-122C-ACDFB2112C21
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
sqlserver_tb_cmp	Object	否
table_cmp_name	String	否		ctt->ctt
src_db_uuid	String	否		4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuid	String	否		40405FD3-DB86-DC8A-81C9-C137B6FDECE5
cmp_type	String	否		user
db_user_map	String	否		{"CTT":"CTT"}
filter_table_settings	String	否		[用户.表名]
db_tb_map	String	否		表映射
dump_thd	Number	否		1
rule_uuid	String	否		5DA7469c-b5d5-Bd53-5ADB-7Eee6D31e60B
policies	String	否		1|00:09	1,2,3*1
policy_type	String	否		periodic
concurrentTab	Array	否		["hh.ww"]
try_split_part_table	Number	否		0
one_time	String	否

表比较 - 删除

SDK方法名：deleteTbCmp

URL

/sqlserver/tb_cmp

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array	否		@guid
force	Boolean			false

Response

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

同步规则-失败的对象

SDK方法名：describeSyncRulesFailObj

URL

/sqlserver/rule/fail_obj

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
offset	Number	否		0
limit	Number	否		10
rule_uuid	String	否		@guid
search	String	否
type	Number		全部：-1; 按对象类型收集错误对象，支持 0="TABLE", 1="TABLE PARTITION", 2="CONSTRAINT", 3="INDEX", 4="VIEW", 5="FUNCTION", 6="PROCEDURE", 7="PACKAGE", 8="PACKAGE BODY", 9="SYNONYM", 10="TRIGGER", 11="SEQUENCE", 12="JAVA SOURCE", 13="JAVA CLASS", 14="JAVA RESOURCE", 15="TYPE", 16="TYPE BODY", 17="QUEUE", 18="MATERIALIZED VIEW", 19="DATABASE LINK", 20="MATERIALIZED VIEW LOG", 21="JOB", 22="OLD JOB", 23="PRIVS", 24="LIBRARY", 25="INDEXTYPE", 26="USER", 27="TABLESPACE", 28="UDT",
stage	Number		所有：-1 全量阶段：0 增量阶段：1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
info_list	Array	否
usr	String	否		222
name	String	否		dd
type	String	否		TABLE
stage	Number		0 全量 1增量	1
total	Number	否		1

表比较 - 列表

SDK方法名：listTbCmp

URL

/sqlserver/tb_cmp

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
total	Number	否		20
info_list	Array	否
create_time	String	否		1593511163
tb_cmp_name	String	否		name321
src_db_uuid	String	否		4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuid	String	否		40405FD3-DB86-DC8A-81C9-C137B6FDECE5
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
tb_cmp_uuid	String	否		C038DE5A-CDB2-F26D-FA5F-93E3FF266A87
tgt_db_name	String	否		bei
username	String	否		admin
can_op	Number	否		1
can_up	Number	否		1
can_del	Number	否		1
is_biz_admin	Number	否		1
src_db_name	String	否		yuan
policy_type	String		immediate; one_time;periodic	immediate
message	String	否

状态接口

SDK方法名：listTbCmpStatus;状态接口

URL

/sqlserver/tb_cmp/status

Method

POST

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
info_list	Array	否			2
cmp_uuid	String	否		@guid
wSt	Object	否	源端
status	String	否		ONLINE
progress	String
bSt	Object	否
status	String	否		DUMP
progress	String	否		80

表比较 历史结果查看表比较时间结果集

SDK方法名：listTbCmpResultTimeList

URL

/sqlserver/tb_cmp/result_time_list

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
time_list	Array	否			16
show_time	String	否		2019-07-05 17:35:13
summary	Object	否
total	Number	否		1192
use_time	Number	否		844
diff	Number	否		130
time	String	否		2019-07-05_17-35-13
total	Number	否		20

表比较-操作

SDK方法名：

停止：stopTbCmp;

重启：restartTbCmp;

URL

/sqlserver/tb_cmp/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tb_cmp_uuids	Array	否		@guid
operate	String	否	cmp_stop | cmp_restart

Response

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

表比较-比较结果的删除

SDK方法名：describeTbCmpResuluTimeList;查看结果删除

URL

/sqlserver/tb_cmp/result_time_list

Method

DELETE

Request

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

Response

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

表比较-比较任务结果

SDK方法名：describeTbCmpResult

URL

/sqlserver/tb_cmp/result

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		1
limit	Number	否		10
search_field	String	否
search_value	String	否
uuid	String	否		@guid
start_time	String	否	对应的时间

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
head_info	Object	否
total	Number	否		100
err	Number	否		10
end	String	否		2019-10-10 12:00:00
start	String	否		2019-10-10 10:00:00
use_time	String	否		3600
result_info	Object	否
rows	Array	否			10
src_user	String	否		user
src_table_name	String	否		Anna Martin
src	String	否		Cynthia Gonzalez
dst	String	否		Robert Johnson
total	Number	否		30

表比较-错误信息

SDK方法名：describeTbCmpErrorMsg;错误信息

URL

/sqlserver/tb_cmp/error_msg

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
offset	Number	否		1
limit	Number	否		10
search_field	String	否
search_value	String	否
uuid	String	否		@guid
start_time	String	否
name	String	否
owner	String	否	所属者	admin

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
result_info	Object	否
rows	Array	否			10
src_row	String	否		@name
dst_row	String	否		@name
total	Number	否		2000

表比较-比较结果

SDK方法名：describeTbCmpCmpResult

URL

/sqlserver/tb_cmp/cmp_result

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
summary	Object	否
total	Number	否		1192
use_time	Number	否		844
diff	Number	否		130