数据检查

SDK类名：/active/DataChk;

示例接口

示例接口描述

URL

/example/1614233102246

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

URL

/datacheck/obj_cmp

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
total	Number	否		20
info_list	Array	否			16
create_time	String	否		1593511163
obj_cmp_uuid	String	否		C038DE5A-CDB2-F26D-FA5F-93E3FF266A87
obj_cmp_name	String	否		test
src_db_uuid	String	否		3D7dFcd9-C176-d9ee-4FFB-f22bbd554926
tgt_db_uuid	String	否		3D7dFcd9-C176-d9ee-4FFB-f22bbd554925
cmp_type	String	否		user
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
src_db_name	String	否		yuan
tgt_db_name	String	否		bei
username	String	否		admin
can_op	Number	否		1
can_up	Number	否		1
can_del	Number	否		1
config	Object
one_task	String			'immediate'
message	String	否

对象比较 - 新建

SDK方法名：createDatacheckObjCmp

URL

/datacheck/obj_cmp

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
obj_cmp_name	String	否	对象比较名称	test
src_db_uuid	String	否	源端数据库uuid	4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuid	String	否	备端数据库uuid	40405FD3-DB86-DC8A-81C9-C137B6FDECE5
src_db_auth_uuid	String
tgt_db_auth_uuid	String
cal_table_recoders	Number	否	是否对比表的记录数	1
rule_uuid	String	否	同步规则uuid	751A03F5-C97D-645B-82B2-316A5D198528
cmp_type	String	否	类型	user
db_user_map	String	否	用户映射	{'src_user':'dst_user'}
policies	String	否	策略
policy_type	String	否	策略类型 one_time 一次性 immediate 立即 periodic 周期性 interval 间隔	periodic
one_time	String	否		2019-05-27 16:07:08
repair	Number	否		1
config	Object
one_task	String		立即比较：immediate 选择时间：select_time	immediate

Response

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

对象比较 - 删除

SDK方法名：deleteDatacheckObjCmp

URL

/datacheck/obj_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	否
success_list	Array				5
code	String			0
message	String
obj_cmp_name	String			@last
obj_cmp_uuid	String			@guid
fail_list	Array				5
code	String			-1
message	String
obj_cmp_name	String			@first
obj_cmp_uuid	String			@guid

对象比较 - 获取单个

SDK方法名：describeDatacheckObjCmp

URL

/datacheck/obj_cmp/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
active_obj_cmp	Object	否
obj_cmp_uuid	String	否
obj_cmp_name	String	否		test
src_db_uuid	String	否		4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuid	String	否		40405FD3-DB86-DC8A-81C9-C137B6FDECE5
rule_uuid	String	否		751A03F5-C97D-645B-82B2-316A5D198528
cmp_type	String	否		user
cal_table_recoders	Number	否		1
db_user_map	String	否		{"user1":"user1"}
policies	String	否		1|00:09	1,2,3*1
policy_type	String	否		periodic
one_time	String	否		2019-05-27 16:07:08
repair	Number	否		1
message	String	否
code	Number	否		0

对象比较 - 操作

SDK方法名： 停止：stopObjCmp; 重启：restartObjCmp; 停止定时：cmpStopTimeObjCmp； 继续定时：cmpResumeTimeObjCmp； 立即比较：cmpImmediateObjCmp；

URL

/datacheck/obj_cmp/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String		cmp_stop (停止) | cmp_restart （重启）	cmp_immediate	（立即比较） cmp_stop_time （停止定时）
obj_cmp_uuids	Array

Response

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

对象比较-比较结果时间列表

SDK方法名：listDatacheckObjCmpResultTimeList

URL

/datacheck/obj_cmp/result_time_list

Method

GET

Request

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

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	否
diff	Number	否			1-100
time	String	否		2019-07-05_17-35-13
total	Number	否		20

对象比较-比较任务结果

SDK方法名：describeDatacheckObjCmpResult

URL

/datacheck/obj_cmp/result

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String	否		@guid
start_time	String	否	开始时间
limit	Number	否
offset	String	否
search_value	String	否	搜索值
BackLackOnly	Number	否	显示备端差异	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
code	Number	否		0
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
result_info	Object	否
total	Number	否		20
rows	Array	否
CONSTRAINT	String	否		1/1__1
DATABASE LINK	String	否		0/0__1
FUNCTION	String	否		0/0__1
INDEX	String	否		4/5__0
JAVA CLASS	String	否		0/0__1
JAVA RESOURCE	String	否		0/0__1
JAVA SOURCE	String	否		0/0__1
JOB	String	否		0/0__1
MATERIALIZED VIEW	String	否		0/0__1
OLD JOB	String	否		0/0__1
PACKAGE	String	否		0/0__1
PACKAGE BODY	String	否		0/0__1
PRIVS	String	否		9/8__0
PROCEDURE	String	否		0/0__1
QUEUE	String	否		0/0__1
SEQUENCE	String	否		0/0__1
SYNONYM	String	否		0/0__1
TABLE	String	否		18/19__0
TABLE PARTITION	String	否		0/0__1
TRIGGER	String	否		0/0__1
TYPE	String	否		0/0__1
TYPE BODY	String	否		0/0__1
VIEW	String	否		2/2__1
usr	String	否		I2/I2
head_info	Object	否
obj_cmp_name	String	否		Michelle Lewis

获取对象比较状态

SDK方法名：listDatacheckObjCmpStatus

URL

/datacheck/obj_cmp/status

Method

POST

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
info_list	Array	否
cmp_uuid	String	否		C038DE5A-CDB2-F26D-FA5F-93E3FF266A87
wSt	Object	否
status	String	否		ERROR
progress	Number	否
error_code	Number			-4022
bSt	Object	否
status	String	否		DUMP
progress	String	否		80
error_code	String			-22
diff_number	Number			10

对象比较-比较结果的删除

SDK方法名：describeDatacheckObjCmpResultTimeList

URL

/datacheck/obj_cmp/result_time_list

Method

DELETE

Request

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

Response

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

对象比较-比较结果详细信息

SDK方法名：listDatacheckObjCmpCmpInfo

URL

/datacheck/obj_cmp/cmp_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
offset	Number	否		1
limit	Number	否		10
search_value	String	否
usr	String	否		I2
filed	String	否
uuid	String	否
start_time	String	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
message	String	否
code	Number	否		0
info_list	Object	否
total	Number	否		2000
rows	Array	否
src	String	否		1111
dst	String	否		2222
cal_table_recoders	Boolean	否	是否比较表的记录	false

表比较 - 新建

SDK方法名：createTbCmp

URL

/datacheck/tb_cmp

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
tb_cmp_name	String	否		规则名
src_db_uuids	Array	否		4CA773F4-36E3-A091-122C-ACDFB2112C21
tgt_db_uuids	Array	否		40405FD3-DB86-DC8A-81C9-C137B6FDECE5
cmp_type	String	否		table
filter_table	Array	否		[user.table]
dump_thd	Number	否	抽取线程数
db_map	Object		整库映射
src	Array
db_uuid	String
auth_uuid	String
tgt	Array
db_uuid	String
auth_uuid	String
db_tb_map	Array	否			5
regex_switch	String		0：关闭正则表名，1：开启	1
src	Array		源端映射列
user	String		用户名	@word
tab	String		列名	@word
dbs	Array		对应数据库节点uuid列表		3
db_uuid	String		数据库节点uuid
auth_uuid	String		数据库节点认证uuid
tgt	Array		备端映射列
user	String		用户名
tab	String		列名
dbs	Array		对应数据库节点uuid列表		3
db_uuid	String		数据库节点uuid
auth_uuid	String		数据库节点认证uuid
col	String		列映射	{"col1":"col2", "col3":"col4"}
db_user_map	Array
src	Array		源端映射列
user	String		用户名
dbs	Array		对应数据库节点uuid列表		3
db_uuid	String		数据库节点uuid
auth_uuid	String		数据库节点认证uuid
tgt	Array		备端映射列
user	String		用户名
dbs	Array		对应数据库节点uuid列表
db_uuid	String		数据库节点uuid
auth_uuid	String		数据库节点认证uuid
polices	String	否	策略	"0|00:00
policy_type	String	否	策略类型;periodic：周期，one_time：一次性任务 ，immediate：立刻执行，interval ：每隔	one_time
interval	String		时间间隔,分钟：10m，小时：10h	10m
concurrent_table	Array	否	并发表	["hh.ww"]
try_split_part_table	Number	否	尝试并发设置 0:否 1：是	0
one_time	String	否	策略的开始时间，如果不是一次性任务为空值	2019-05-27 16:07:08
config	Object
globalConfig	Object
dkdiff_enable_step_count_table	String		启用count类型 不启用count比对：‘’ 仅count比对：onlycount 比较时count:ondiff 默认值：空	""
dkdbsource_diff_only_key_columns	Boolean		关闭：false, 开启：true	false
dkmagic_plan_max_diffs	Number		值: 整数（-1表示不限制)	10000
dkfilesink_enable_sqlpatch_file	Boolean		关闭：false, 开启：true	false
dkmagic_plan_number_tolerance_type	String		绝对差值 absolute, 相对差值 relative	absolute
dkmagic_plan_number_tolerance	Number		绝对差值 正数 相对差值 0~1
dkmagic_plan_datetime_tolerance	Number		时间容差 正数
split_table_schedule_cron	String		大表拆分类型 不拆分：空, 比较时进行拆分：immediate	""
split_table_single_segment_max_rows	Number		拆分后单个计划最大行数 正整数	5000000
split_table_result_expire_in_seconds	Number		拆分结果最大过期时间 非负整数 (单位: 秒)	0
dkdiffengine_recursion_max_steps	Number		"递归比对"最大次数 正整数（>=1）	1
dkdiffengine_recursion_interval_step_delay	Number		每次“递归”的时间间隔 值：非负整数(单位：毫秒) 默认值：0	0
dkdbsource_left_ignore_type_names	String		源端忽略类型 值：字符串 (多个类型用逗号分隔) 默认值：空	""
dkdbsource_right_ignore_type_names	String		备端忽略类型 值：字符串 (多个类型用逗号分隔) 默认值：空	""
dkdbsource_left_ignore_column_names	String		源端忽略列名 值：字符串 (多个列名用逗号分隔) 默认值：空	""
dkdbsource_right_ignore_column_names	String		备端忽略列名 值：字符串 (多个列名用逗号分隔) 默认值：空
globalconfig	Array
key	String		key
value	String		value
tolerance	Boolean		是否启用容差值比对 默认 false	false
execute_patch_after_complete	String		自动修复
data_select	Array		单表筛选配置
src_user	String
src_tb	String
src_query	String
dst_user	String
dst_tb	String
dst_query	String
compare_key	Array		比较key列
src_user	String
src_tb	String
dst_user	String
dst_tb	String
src_dst_key	String
globals	Array		全局筛选配置
src_user	String
dst_user	String
src_query	String
dst_query	String
exclude_tables	Array		排除表配置
src_user	String
src_tb	String
dst_user	String
dst_tb	String
timestamps	Object
column_name	String		时间戳字段名称
back_delay_in_seconds	Number		追溯时间间隔
end_time	String		最新时间
global_time_limit	Boolean		是否开启全局时间限制比对
v_tabmap	Array
src_user	String		源端用户
src_tb	String		源端表名
src_sql	String		源端SQL
tgt_user	String		备端用户
tgt_tb	String		备端表名
tgt_sql	String		备端SQL
key	String		key列

Response

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

表比较 - 获取单个

SDK方法名：describeTbCmp

URL

/datacheck/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	否
active_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	否		2019-05-27 16:07:08

表比较 - 删除

SDK方法名：deleteTbCmp

URL

/datacheck/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方法名：listTbCmp

URL

/datacheck/tb_cmp

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		1
limit	Number	否		10
search_field	String	否		tb_cmp_name
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方法名：listTbCmpResultTimeList

URL

/datacheck/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;

继续：resumeTbCmp;

URL

/datacheck/tb_cmp/operate

Method

POST

Request

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

Response

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

表比较-比较结果的删除

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

URL

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

/datacheck/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	否	对应的时间
flag	Number		0:仅显示差异表 1:显示所有比对表

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
src_diff_msg	String		差异描述
dst_diff_msg	String
aggregate	Number		是否聚合查询0：不聚合，1：聚合（控制页面的查看按钮，0时不显示）
total	Number	否		30
rule_related	Number		是否关联规则0：关，1：开
only_count	Number		是否仅count。0：关，1：开（1的时候不显示操作列 ）

表比较-错误信息

SDK方法名：describeTbCmpErrorMsg;错误信息

URL

/datacheck/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
src_db	Array		源端数据库名	@name
tgt_db	Array		备端数据库名	test
total	Number	否		2000

表比较-比较结果

SDK方法名：describeTbCmpCmpResult

URL

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

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

表比较-表比对的详细信息

SDK方法名：describeTbCmpCmpDesc;表比对的详细信息

URL

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

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	否
diff	Object	否			10
srcSchema	Array		源端用户
name	String		源端表名	srcTableName
dstSchema	String		备端schema名称	dstSchema
dstName	String		备端表名	dstTableName
user	String		用户	user
maxSteps	Number		该表最大执行步数	2
plans	Array
plan	String		计划名称	plan15
recursions	Array		一个执行计划可以有多个执行步(递归比对
srow	Number			3
drow	Number			3
srcSql	Array			[ "select id,c1,c2,c3 from srcSchema.srcTableName where id<10000" ],
dstSql	Array			[ "select id,c1,c2,c3 from dstSchema.dstTableName where id<10000" ]

表比较-启动表比对

SDK方法名：describeTbCmpStart

URL

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

Method

GET

Request

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

Response

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