数据脱敏

February 26, 2024About 35 min

数据脱敏

SDK类名：/active/Mask

------敏感类型-------

URL

/敏感类型

Method

GET

Request

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

Response

名称	类型	必选	Mock初始值	Mock规则
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
total	Number	否	0
message	String	否
list	Array	否		4
id	Number	否		0-100
type_name	String	否	@name
description	String	否	@name

敏感类型列表

SDK方法名：listTypes

URL

/mask/sens_type

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		0
limit	Number	否		10

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
info_list	Array		10
algo_name	Array	["屏蔽姓名","屏蔽身份证出生月日","屏蔽手机号码","屏蔽地址关键信息","屏蔽银行卡号","屏蔽邮箱用户名","屏蔽组织机构名称关键信息","屏蔽组织机构代码","屏蔽营业执照号码","屏蔽统一社会信用代码"]	+1
algo_desc	Array	["屏蔽姓名中的名字","屏蔽身份证号码中的出生月日（区间[11,14]）","屏蔽手机号码中的地区编码（区间[4,7]）","屏蔽关键信息，只保留省市信息和“区县镇路街道弄幢号楼栋单元室”等关键字","屏蔽银行卡号中前四位和后四位外的其它位（区间[4,-4]）","屏蔽邮箱用户名，保留邮箱域名","屏蔽关键信息，只保留“公司所局厅部院”等关键字","屏蔽组织机构代码（区间[3,7]）","屏蔽营业执照号码中的顺序码（区间[7,14]）","屏蔽统一社会信用代码中的主体标识码（区间[9,17]）"]	+1
algo_params	Array	["[{"name":"偏移量","key":"off","value":"1","setted":1,"type":"int"},{"name":"长度","key":"len","value":"0","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"","setted":0,"type":"string"}]","[{"name":"偏移量","key":"off","value":"10","setted":1,"type":"int"},{"name":"长度","key":"len","value":"4","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"","setted":0,"type":"string"}]","[{"name":"偏移量","key":"off","value":"3","setted":1,"type":"int"},{"name":"长度","key":"len","value":"4","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"","setted":0,"type":"string"}]","[]","[{"name":"偏移量","key":"off","value":"4","setted":1,"type":"int"},{"name":"长度","key":"len","value":"-4","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"","setted":0,"type":"string"}]","[]","[]","[{"name":"偏移量","key":"off","value":"2","setted":1,"type":"int"},{"name":"长度","key":"len","value":"5","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"","setted":0,"type":"string"}]","[{"name":"偏移量","key":"off","value":"6","setted":1,"type":"int"},{"name":"长度","key":"len","value":"8","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"","setted":0,"type":"string"}]","[{"name":"偏移量","key":"off","value":"8","setted":1,"type":"int"},{"name":"长度","key":"len","value":"9","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"*","setted":0,"type":"string"}]"]	+1
username	Null
user_uuid	String	00000000-0000-0000-0000-000000000000
id	Number	1	+1
type_name	Array	["姓名","身份证号","手机号码","地址","银行卡号","电子邮箱","组织机构名称","组织机构代码","营业执照号码","统一社会信用代码"]	+1
description	Array	["由姓氏与名字组成，用于识别某一个人。","居民身份证号码，是国家法定的证明公民个人身份的有效证件的号码。","网络用户的个人手机号码，是移动用户对外公开的电话号码。","个人的居住地点信息或机关团体的所在地信息。","银行发行的硬卡上的编号代码，用于区分银行卡。","网络上标识着可以收发电子邮件的网络域名。","用于识别依法建立的国家机构或社会组织的专属名词。","机关、企事业单位、社会团体以及其他组织机构在全国范围内唯一的代码标识。","工商企业、个体经营者被准许从事某项生产经营活动的营业执照凭证的号码。","法人和其他组织统一社会信用代码。"]	+1
sort	Number	0
create_time	String	0
params	String
parent_id	Number	1	+1
default_algo	Number	1301	+1
default_algo_params	Array		3
name	Array	["偏移量","长度","屏蔽字符"]	+1
key	Array	["off","len","val"]	+1
value	Array	["1","0","*"]	+1
setted	Number	1	+1
type	Array	["int","int","string"]	+1
total	Number	19
can_up	Number	1

获取总览列表

SDK方法名：listSummaryView

URL

/mask/summary/list_view

Method

GET

Request

名称	类型	必选	简介
src	String	否
dst	String	否
status	String	否	all:不过滤默认传all
type	String	否	all:不过滤默认传 all
ip	String	否

Response

名称	类型	必选	简介	Mock初始值	Mock规则
message	String	否		success
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
total	Number	否		20
message	String	否
info_list	Array	否			5
rule_name	String	否		@name
rule_uuid	String	否		e2F1DbC3-5f63-e181-d1a7-43693E6Cc705
src_db_name	String	否		db-199
tgt_db_name	String	否		db-200
load	String	否	装载时间----启动时间	2020-03-09 09:55:21
bytes	String	否	流量	165.4MB
compress	String	否	压缩率	100.00
delay	String	否		424ms
stage	String	否	track，error，unknow，dump，stop, doing,fix	fix
type	Array	否	oracle，kafka，mysql	['oracle', 'kafka', 'mysql', 'sqlserver', 'postgres']	+1
extract	String			2020-03-09 09:55:21

修改敏感类型

SDK方法名：modifySensType

URL

/mask/sens_type/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	Mock初始值	Mock规则
algo_name	String	屏蔽姓名
algo_desc	String	屏蔽姓名中的名字
algo_params	String	[{"name":"偏移量","key":"off","value":"1","setted":1,"type":"int"},{"name":"长度","key":"len","value":"0","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"*","setted":0,"type":"string"}]
username	String	test
user_uuid	String	00000000-0000-0000-0000-000000000000
id	Number	1
type_name	String	姓名
description	String	由姓氏与名字组成，用于识别某一个人。
sort	Number	0
create_time	String	0
params	String
parent_id	Number	1
default_algo	Number	1301
default_algo_params	Array		3
name	Array	["偏移量","长度","屏蔽字符"]	+1
key	Array	["off","len","val"]	+1
value	Array	["1","0","*"]	+1
setted	Number	1	+1
type	Array	["int","int","string"]	+1
_	String	704098f4051d7

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String

获取单个类型

SDK方法名：descriptSensType;

URL

/mask/sens_type/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
sens_type	Object
algo_name	String	屏蔽银行卡号
algo_desc	String	屏蔽银行卡号中前四位和后四位外的其它位（区间[4,-4]）
algo_params	String	[{"name":"偏移量","key":"off","value":"4","setted":1,"type":"int"},{"name":"长度","key":"len","value":"-4","setted":1,"type":"int"},{"name":"屏蔽字符","key":"val","value":"*","setted":0,"type":"string"}]
id	Number	5
type_name	String	银行卡号
description	String	银行发行的硬卡上的编号代码，用于区分银行卡。
user_uuid	String	00000000-0000-0000-0000-000000000000
parent_id	Number	5
default_algo	Number	1304
default_algo_params	Null
params	String
sort	Number	0
create_time	String	0
can_up	Number	1

------- 脱敏算法-------

URL

/脱敏算法

Method

GET

Request

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

Response

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

新建脱敏算法

SDK方法名：createAlgo

URL

/mask/algo

Method

POST

Request

名称	类型	必选	简介	Mock初始值
ava_sens_type	Number	否	作用于某个类型	1
parent_id	Number	否	父类算法id	1
algo_name	String	否	算法名称
description	String	否	算法描述
params	String	否	算法参数
sort	String	否	排序规则

Response

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

脱敏算法列表

SDK方法名：listAlgos

URL

/mask/algo

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		0
limit	Number	否		10

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
info_list	Array		10
sens_type_name	Array	["姓名","身份证号","手机号码","电子邮箱","电子邮箱","组织机构代码","营业执照号码","统一社会信用代码","中国护照号码","固定电话号码"]	+1
username	Null
user_uuid	String	00000000-0000-0000-0000-000000000000
id	Number	301	+1
algo_name	Array	["生成姓名","生成身份证号码","生成手机号码","生成电子邮箱","生成电子邮件用户名","生成组织机构代码","生成营业执照号码","生成统一社会信用代码","生成中国护照号码","生成固定电话号码"]	+1
description	Array	["随机生成姓名","随机生成身份证号码","随机生成手机号码","随机生成电子邮箱","随机生成用户名，邮件地址保持不变","随机生成组织机构代码","随机生成营业执照号码","随机生成统一社会信用代码","随机生成中国护照号码","随机生成固定电话号码"]	+1
type	Number	0
params	Array
parent_id	Number	301	+1
ava_sens_type	Number	1	+1
sort	Number	900
example	Null
is_biz_admin	Number	1
can_del	Number	1
can_op	Number	1
can_up	Number	1
total	Number	57

获取单个算法

SDK方法名：descriptAlgo

URL

/mask/algo/:id

Method

GET

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
algo	Object
id	Number	313
algo_name	String	生成固定电话号码
type	Number	0
use_type	String
ava_sens_type	Number	13
description	String	随机生成固定电话号码
parent_id	Number	313
params	Array
sort	Number	900
example	Null
user_uuid	String	00000000-0000-0000-0000-000000000000
create_time	String	0
is_biz_admin	Number	1
can_del	Number	1
can_op	Number	1
can_up	Number	1

------ 脱敏规则------

URL

/ 脱敏规则

Method

GET

Request

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

Response

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

脱敏规则列表

SDK方法名：listMaskRules

URL

/mask/rule

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否		10
page	Number	否		0

Response

名称	类型	简介	Mock初始值	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
info_list	Array
src_db_name	String		db103
tgt_db_name	String		db105
db_map_name	String		12312
start	String		2020-09-29 10:04:04
end	String
mask_node_name	String		103
mask_node_uuid	String		A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
username	String		admin
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String		BFD56508-9FCB-1FFF-749B-FCA2E78B4CD6
src_db_uuid	String		38F1AD45-5F72-2E51-DC01-0593A14A8D17
tgt_db_uuid	String		32C50055-A267-1E9E-65EE-FC6AAB75D390
rule_type	Number		1
map_type	String		db
rule_name	String		123123
tgt_type	String		oracle
create_time	Number		1601345043
strate	Array			2
type_id	Number		1	+1
type_arg	String
algo_pid	Number		4
algo_id	Number		1301	+1
sens_column	Array
user	String		123
table	String		123
column	String		123
algo_arg	Array			3
name	Array		["偏移量","长度","屏蔽字符"]	+1
key	Array		["off","len","val"]	+1
value	Array		["1","0","*"]	+1
setted	Number		1	+1
type	Array		["int","int","string"]	+1
sens_map_id	Array		["1","2"]	+1
db_map_uuid	String		71D59BCE-17F3-ED0D-BC76-132833F72498
other_settings	Object
src_type	String		oracle
tgt_type	String		oracle
src_path	String		/var/i2data/cache/
file_names	Array
size	Number		1024
tgt_path	String		/var/i2data/cache/
compress_level	Number		0
policy	Object
policy_type	String		immediate
one_time	String
time_policy	String
can_approve	Number	审批 1：已经审批通过 2. 未审批	0
is_biz_admin	Number		1
can_del	Number		1
can_op	Number		1
can_up	Number		1
total	Number		1

新建脱敏规则

SDK方法名：createMaskRules

URL

/mask/rule

Method

POST

Request

名称	类型	简介	Mock初始值
rule_name	String		1231
node_uuid	String		A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
tgt_db_uuid	String		32C50055-A267-1E9E-65EE-FC6AAB75D390
src_db_uuid	String		38F1AD45-5F72-2E51-DC01-0593A14A8D17
other_settings	Object
src_type	String	脱敏文件：csv，	oracle
tgt_type	String		oracle
src_path	String		/var/i2data/cache/
file_names	Array
size	Number		1024
tgt_path	String		/var/i2data/cache/
compress_level	Number		0
policy	Object
policy_type	String		immediate
one_time	String
time_policy	String
etl_settings	Object
etl_table	Array
table	String
user	String
addInfo	String
oprType	String
process	String
can_approve	Number		0
table_space_map	Object
tgt_table_space	String
table_mapping_way	String		ptop
table_path_map	Array
table_space_name	Array
full_sync_obj_filter	Array		["INDEX","VIEW","FUNCTION","PROCEDURE","PACKAGE","PACKAGE BODY","SYNONYM","TRIGGER","SEQUENCE","JAVA CLASS","TYPE","TYPE BODY","MATERIALIZED VIEW","OLD JOB","JOB","PRIVS","CONSTRAINT","JAVA RESOURCE","JAVA SOURCE"]
db_user_map	String
table_map	String
map_type	String		db
full_sync_settings	Object
his_thread	Number		1
db_map_uuid	String		71D59BCE-17F3-ED0D-BC76-132833F72498
strate	String
modify	Boolean		0
_	String		a39e1c5b7e511
bw_settings	Object
bw_limit	String

Response

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

操作脱敏规则

SDK方法名：operateMaskRule;

URL

/mask/rule/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	start \| stop
uuids	String	否

Response

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

删除脱敏规则

SDK方法名：deleteMaskRule

URL

/mask/rule

Method

DELETE

Request

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

Response

名称	类型	Mock初始值
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	2222
fail_list	Array
code	Number	-1
message	String	[-1] 找不到节点
rule_uuid	String	16CB63E1-13FA-FB32-EB49-D790682C9647
rule_name	String	123123

获取单条脱敏规则

SDK方法名：describeMaskRule;

URL

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

Method

GET

Request

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

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
rule	Object
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String	BFD56508-9FCB-1FFF-749B-FCA2E78B4CD6
src_db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
tgt_db_uuid	String	32C50055-A267-1E9E-65EE-FC6AAB75D390
rule_type	Number	1
rule_name	String	123123
node_uuid	String	A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
tgt_type	String	oracle
db_user_map	String
row_map_mode	Null
map_type	String	db
table_map	String
dbmap_topic	Null
sync_mode	String	1
start_scn	Null
storage_settings	Null
table_space_map	Object
tgt_table_space	String
table_mapping_way	String	ptop
table_path_map	Array
table_space_name	Array
other_settings	Object
src_type	String	oracle
tgt_type	String	oracle
src_path	String	/var/i2data/cache/
file_names	Array
size	Number	1024
tgt_path	String	/var/i2data/cache/
compress_level	Number	0
policy	Object
policy_type	String	immediate
one_time	String
time_policy	String
error_handling	Null
bw_settings	Null
strate	Array		2
type_id	Number	1	+1
type_arg	String
algo_pid	Number	4
algo_id	Number	1301	+1
sens_column	Array
user	String	123
table	String	123
column	String	123
algo_arg	Array		3
name	Array	["偏移量","长度","屏蔽字符"]	+1
key	Array	["off","len","val"]	+1
value	Array	["1","0","*"]	+1
setted	Number	1	+1
type	Array	["int","int","string"]	+1
sens_map_id	Array	["1","2"]	+1
algo_name	Array	["屏蔽姓名","屏蔽身份证出生月日"]	+1
sens_type_name	Array	["姓名","身份证号"]	+1
full_sync_settings	Object
his_thread	Number	1
full_sync_obj_filter	Array	["INDEX","VIEW","FUNCTION","PROCEDURE","PACKAGE","PACKAGE BODY","SYNONYM","TRIGGER","SEQUENCE","JAVA CLASS","TYPE","TYPE BODY","MATERIALIZED VIEW","OLD JOB","JOB","PRIVS","CONSTRAINT","JAVA RESOURCE","JAVA SOURCE"]
inc_sync_ddl_filter	Null
filter_table_settings	Null
etl_settings	Null
create_time	Number	1601345043
start_rule_now	Number	1
db_map_uuid	String	71D59BCE-17F3-ED0D-BC76-132833F72498
dml_track	String
kafka_time_out	String	12000
part_load_balance	String	by_key
kafka_message_encoding	String	UTF-8
kafka	String
biz_grp_list	Array
biz_grp_name	Array

获取脱敏状态

SDK方法名：listMaskRuleStatus

URL

/mask/rule/status

Method

POST

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
info_list	Array
rule_uuid	String	BFD56508-9FCB-1FFF-749B-FCA2E78B4CD6
export_state	Object
status	String	ACTIVE_RULE_STOP
progress	Number	0
error_code	Number	-2
load_state	Object
status	String	ACTIVE_RULE_PAUSE
progress	Number	0
mask_state	Object
status	String	ACTIVE_RULE_ABNORMAL
progress	Number	0
error_code	Number	-4017
src_state	String	NORMAL
dst_state	String	NORMAL
end	String
src_db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
tgt_db_uuid	String	32C50055-A267-1E9E-65EE-FC6AAB75D390
node_uuid	String	A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
src_db_info	Object
db_ip	Array	["172.20.2.103"]
db_name	String	db103
server_name	String	orcl
status	String	NORMAL
node_ip	String	172.20.2.103
node_name	String	103
tgt_db_info	Object
db_ip	Array	["172.20.2.105"]
db_name	String	db105
server_name	String	orcl
status	String	NORMAL
node_ip	String	172.20.2.105
node_name	String	node105
mask_node_info	Object
node_ip	String	172.20.2.103
node_name	String	103
status	String	ONLINE
mask_status	String	ok
os	String	CentOS release 6.5 (Final)

-------敏感集合-------

URL

/敏感集合

Method

GET

Request

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

Response

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

获取单个集合

SDK方法名：descriptMap

URL

/mask/sens_db_map/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	简介	Mock初始值	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
sens_db_map	Object
username	String		admin
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
map_name	String		12312
map_uuid	String		71D59BCE-17F3-ED0D-BC76-132833F72498
db_uuid	String		38F1AD45-5F72-2E51-DC01-0593A14A8D17
type_algo_map	Array			19
type_name	Array		["姓名","身份证号","手机号码","地址","银行卡号","电子邮箱","组织机构名称","组织机构代码","营业执照号码","统一社会信用代码","中国护照号码","固定电话号码","港澳来往内地通行证","往来港澳通行证","IPv4地址","日期","日期字符串","通用字符串","数值"]	+1
id	Number		1	+1
algo_name	Array		["屏蔽姓名","屏蔽身份证出生月日","屏蔽手机号码","屏蔽地址关键信息","屏蔽银行卡号","屏蔽邮箱用户名","屏蔽组织机构名称关键信息","屏蔽组织机构代码","屏蔽营业执照号码","屏蔽统一社会信用代码","屏蔽中国护照号码","屏蔽固定电话号码","屏蔽港澳居民来往内地通行证","屏蔽往来港澳通行证","屏蔽IPv4地址","保留日期类型的年份","保留日期字符串的年份",null,null]	+1
default_algo	Number		1301	+1
default_algo_params	Array			3
name	Array		["偏移量","长度","屏蔽字符"]	+1
key	Array		["off","len","val"]	+1
value	Array		["1","0","*"]	+1
setted	Number		1	+1
type	Array		["int","int","string"]	+1
algo_desc	Array		["屏蔽姓名中的名字","屏蔽身份证号码中的出生月日（区间[11,14]）","屏蔽手机号码中的地区编码（区间[4,7]）","屏蔽关键信息，只保留省市信息和“区县镇路街道弄幢号楼栋单元室”等关键字","屏蔽银行卡号中前四位和后四位外的其它位（区间[4,-4]）","屏蔽邮箱用户名，保留邮箱域名","屏蔽关键信息，只保留“公司所局厅部院”等关键字","屏蔽组织机构代码（区间[3,7]）","屏蔽营业执照号码中的顺序码（区间[7,14]）","屏蔽统一社会信用代码中的主体标识码（区间[9,17]）","屏蔽中国护照号码中间三位字符（区间[3,5]）","屏蔽固定电话号码中其中三位（区间[-5,-2]）","屏蔽港澳居民来往内地通行证号码（区间[4,7]）","屏蔽往来港澳通行证号码（区间[4,7]）","屏蔽IPv4地址的点分十进制后两段","保留日期类型的年份不变","保留日期字符串的年份不变",null,null]	+1
create_time	String		1601344326
is_biz_admin	Number		1
can_del	Number		1
can_op	Number		1
can_up	Number		1
src_type	String	[oracle\|expdmp]
src_path	String
rule_occ_flag	Number	0 没占用 1 占用	1

类型列表

SDK方法名：listMap

URL

/mask/sens_map

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否
limit	Number	否

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
can_op	Number	1
info_list	Array		2
sens_type_name	Array	["身份证号","姓名"]	+1
default_algo_name	Array	["屏蔽身份证出生月日","屏蔽姓名"]	+1
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
map_id	Array	["2","1"]	+1
db_map_uuid	String	71D59BCE-17F3-ED0D-BC76-132833F72498
sens_type_id	Number	2	+1
sens_column	Array
user	String	123
table	String	123
column	String	123
default_algo_params	Array		3
name	Array	["偏移量","长度","屏蔽字符"]	+1
key	Array	["off","len","val"]	+1
value	Array	["10","4","*"]	+1
setted	Number	1	+1
type	Array	["int","int","string"]	+1
default_algo_id	Number	1307	+1
description	Null
sort	String	0
create_time	Array	["1601344344","1601344338"]	+1
total	Number	2

新建集合

SDK方法名：createMap

URL

/mask/sens_map

Method

POST

Request

名称	类型	必选	简介	Mock初始值
map_name	String	否
sens_type_id	String	否
sens_column	Array	否
user	String	否		I2MASK
table	String	否		MP
column	String	否		MP
src_type	String		[oracle\|expdmp]
src_path	String

Response

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

修改集合

SDK方法名：modifyMap

URL

/mask/sens_map/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值
map_name	String	否
sens_type_id	String	否
sens_column	Array	否
user	String	否		I2MASK
table	String	否		MP
column	String	否		MP
src_type	String		[oracle\|expdmp]
src_path	String

Response

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

删除集合

SDK方法名：deleteMap

URL

/mask/sens_map

Method

DELETE

Request

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

Response

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

新建数据库集合

SDK方法名：createDbMap

URL

/mask/sens_db_map

Method

POST

Request

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

Response

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

数据库集合列表

SDK方法名：listDbMap

URL

/mask/sens_db_map

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		0
limit	Number	否		10

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
info_list	Array
db_name	String	db103
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
map_name	String	12312
map_uuid	String	71D59BCE-17F3-ED0D-BC76-132833F72498
db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
type_algo_map	Array		19
type_name	Array	["姓名","身份证号","手机号码","地址","银行卡号","电子邮箱","组织机构名称","组织机构代码","营业执照号码","统一社会信用代码","中国护照号码","固定电话号码","港澳来往内地通行证","往来港澳通行证","IPv4地址","日期","日期字符串","通用字符串","数值"]	+1
id	Number	1	+1
algo_name	Array	["屏蔽姓名","屏蔽身份证出生月日","屏蔽手机号码","屏蔽地址关键信息","屏蔽银行卡号","屏蔽邮箱用户名","屏蔽组织机构名称关键信息","屏蔽组织机构代码","屏蔽营业执照号码","屏蔽统一社会信用代码","屏蔽中国护照号码","屏蔽固定电话号码","屏蔽港澳居民来往内地通行证","屏蔽往来港澳通行证","屏蔽IPv4地址","保留日期类型的年份","保留日期字符串的年份",null,null]	+1
default_algo	Number	1301	+1
default_algo_params	Array		3
name	Array	["偏移量","长度","屏蔽字符"]	+1
key	Array	["off","len","val"]	+1
value	Array	["1","0","*"]	+1
setted	Number	1	+1
type	Array	["int","int","string"]	+1
algo_desc	Array	["屏蔽姓名中的名字","屏蔽身份证号码中的出生月日（区间[11,14]）","屏蔽手机号码中的地区编码（区间[4,7]）","屏蔽关键信息，只保留省市信息和“区县镇路街道弄幢号楼栋单元室”等关键字","屏蔽银行卡号中前四位和后四位外的其它位（区间[4,-4]）","屏蔽邮箱用户名，保留邮箱域名","屏蔽关键信息，只保留“公司所局厅部院”等关键字","屏蔽组织机构代码（区间[3,7]）","屏蔽营业执照号码中的顺序码（区间[7,14]）","屏蔽统一社会信用代码中的主体标识码（区间[9,17]）","屏蔽中国护照号码中间三位字符（区间[3,5]）","屏蔽固定电话号码中其中三位（区间[-5,-2]）","屏蔽港澳居民来往内地通行证号码（区间[4,7]）","屏蔽往来港澳通行证号码（区间[4,7]）","屏蔽IPv4地址的点分十进制后两段","保留日期类型的年份不变","保留日期字符串的年份不变",null,null]	+1
create_time	String	1601344326
is_biz_admin	Number	1
can_del	Number	1
can_op	Number	1
can_up	Number	1
db_info	Object
db_ip	Array	["172.20.2.103"]
db_name	String	db103
server_name	String	orcl
status	String	NORMAL
node_ip	String	172.20.2.103
node_name	String	103
src_type	String
src_path	String
total	Number	1

删除数据库集合

SDK方法名：deleteDbMap

URL

/mask/sens_db_map

Method

DELETE

Request

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

Response

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

修改数据库集合

SDK方法名：modifyDbMap

URL

/mask/sens_db_map/:uuid([A-F0-9-]+)

Method

PUT

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String

--------- 敏感发现---------

URL

/mask_find

Method

GET

Request

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

Response

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

新建敏感发现任务

SDK方法名：createSensCheck

URL

/mask/sens_check

Method

POST

Request

名称	类型	简介	Mock初始值
rule_uuid	String
rule_name	String		adsas
src_db_uuid	String		38F1AD45-5F72-2E51-DC01-0593A14A8D17
mask_node_uuid	String		A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
user	String
tabs	String
row	Number		100
min	Number		90
sens_types	String		1,2,3,4,5,6,7,8,9,10,12,13,14,15,20
map_type	String		db
mix	Number		0
white	Number		1
_	String		25bc5f36e5175
src_type	String	[oracle\|expdmp]
src_path	String

Response

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

修改敏感发现任务

SDK方法名：modifySensCheck

URL

/mask/sens_check/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	Mock初始值
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String	F895D958-F435-47AC-664D-805BA7DFEE89
rule_name	String	asd
map_type	String	db
src_db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
user	String
tabs	String
row	Number	100
min	Number	90
sens_types	String	1,2,3,4,5,6,7,8,9,10,12,13,14,15,20
create_time	String	1601344305
mask_node_uuid	String	A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
mix	Number	0
status	Number	0
start	String	2020-09-29 09:51:45
end	String
white	Number	1
info	String

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。

删除敏感发现任务

SDK方法名：deleteSensCheck

URL

/mask/sens_check/delete

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	String	否	uuid 之间逗号相隔

Response

名称	类型	必选	Mock初始值
ret	Number	否	200
msg	String	否
data	Object	否
code	Number	否	0
message	String	否
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		test1
fail_list	Array
code	Number		-1
message	String		[-1] 找不到节点
rule_uuid	String		16CB63E1-13FA-FB32-EB49-D790682C9647
rule_name	String		test2

获取敏感发现列表

SDK方法名：listSensCheck

URL

/mask/sens_check

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		0
limit	Number	否		10

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
info_list	Array		2
src_db_name	String	db103
mask_node_name	String	103
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	Array	["F895D958-F435-47AC-664D-805BA7DFEE89","C85DEA2C-BE93-B1C9-38A0-3841B2B76832"]	+1
rule_name	Array	["asd","123123"]	+1
map_type	String	db
src_db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
user	String
tabs	String
row	Number	100
min	Number	90
sens_types	String	1,2,3,4,5,6,7,8,9,10,12,13,14,15,20
create_time	Array	["1601344305","1601342999"]	+1
mask_node_uuid	String	A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
mix	Number	0
status	Number	0
start	Array	["2020-09-29 09:51:45","2020-09-29 09:29:59"]	+1
end	String
white	Number	1
info	String
is_biz_admin	Number	1
can_del	Number	1
can_op	Number	1
can_up	Number	1
src_type	String
src_path	String
total	Number	2

获取单个任务详情

SDK方法名：descriptSensCheck

URL

/mask/sens_check/:uuid([A-F0-9-]+)

Method

GET

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
sens_check	Object
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String	F895D958-F435-47AC-664D-805BA7DFEE89
rule_name	String	asd
map_type	String	db
src_db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
user	String
tabs	String
row	Number	100
min	Number	90
sens_types	String	1,2,3,4,5,6,7,8,9,10,12,13,14,15,20
create_time	String	1601344305
mask_node_uuid	String	A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
mix	Number	0
status	Number	0
start	String	2020-09-29 09:51:45
end	String
white	Number	1
info	String
is_biz_admin	Number	1
can_del	Number	1
can_op	Number	1
can_up	Number	1

获取任务状态

SDK方法名：listSensCheckStatus;

URL

/mask/sens_check/status

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	String	否	uuid 之间用逗号相隔

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
info_list	Array		2
rule_uuid	Array	["F895D958-F435-47AC-664D-805BA7DFEE89","C85DEA2C-BE93-B1C9-38A0-3841B2B76832"]	+1
status	String	['ACTIVE_RULE_UNKNOWN', 'OFFLINE']	+1
progress	Number	0
type	Number	0
total	String	-
cur	String	-
start	Array	["2020-09-29 09:51:45","2020-09-29 09:29:59"]	+1
end	String	-
db_info	Object
db_ip	Array	["172.20.2.103"]
db_name	String	db103
server_name	String	orcl
status	String	NORMAL
node_ip	String	172.20.2.103
node_name	String	103

获取结果

SDK方法名：listSensCheckResult;

URL

/mask/sens_check/result/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选
uuid	String	否
type	String	否
user	String	否
table	String	否
limit	Number	否
page	Number	否

Response

名称	类型	必选	Mock初始值	Mock规则
code	Number	否	0
message	String	否	[0] 操作成功。
total	Number	否	10
info_list	Array	否		10
sens_type_name	String	否	姓名
type_id	Number	否	1
user	String	否	TEST
table	String	否	MASK_BASE
col	String	否	NAME
check	String	否	100
row	Number	否	96
hit	Number	否	96
comment	String	否
ignore	String	否
start	String	否	2020-03-19 14:51:11
end	String	否	2020-03-19 14:51:13

忽略列获取结果

SDK方法名：listSensCheckIgnoreCol;

URL

/mask/sens_check/ignore_col

Method

POST

Request

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

Response

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

总览页面

SDK方法名：listSummary

URL

/mask/summary

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
proxyStatus	String	否		online
info	Object	否
result	Number	否		0
summary	Object	否
dbs	Object	否
normal	Number	否		5
warn	Number	否		0
abnormal	Number	否		36
unknown	Number	否		0
nodes	Object	否
online	Number	否		3
offline	Number	否		0
inactive	Number	否		0
unknown	Number	否		7
rules	Object	否
error	Number	否	错误	0
unknown	Number	否	未知	7
done	Number	否	完成	3
doing	Number	否	运行	3
stop	Number	否	停止	1
wait	Number		等待	1

算法测试

SDK方法名：algoTest

URL

/mask/algo/test

Method

POST

Request

名称	类型	Mock初始值
example	Object
orig	String	1231
mask	String	-
parent_id	Number	308
ava_sens_type	Number	8
type_arg	String
id	Number	308
params	Array
_	String	713d0acaa3283

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String

修改规则·

SDK方法名：modifyMaskRules

URL

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

Method

PUT

Request

名称	类型	必选	Mock初始值	Mock规则
username	String		admin
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String		BFD56508-9FCB-1FFF-749B-FCA2E78B4CD6
src_db_uuid	String		38F1AD45-5F72-2E51-DC01-0593A14A8D17
tgt_db_uuid	String		32C50055-A267-1E9E-65EE-FC6AAB75D390
rule_type	Number		1
rule_name	String		123123
node_uuid	String		A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
tgt_type	String		oracle
db_user_map	String
row_map_mode	Null
map_type	String		db
table_map	String
dbmap_topic	Null
sync_mode	String		1
start_scn	Null
storage_settings	Null
table_space_map	Object
tgt_table_space	String
table_mapping_way	String		ptop
table_path_map	Array
table_space_name	Array
other_settings	Object
src_type	String		oracle
tgt_type	String		oracle
src_path	String		/var/i2data/cache/
file_names	Array
size	Number		1024
tgt_path	String		/var/i2data/cache/
compress_level	Number		0
policy	Object
policy_type	String		immediate
one_time	String
time_policy	String
error_handling	Null
bw_settings	Null
strate	Array			2
type_id	Number		1	+1
type_arg	String
algo_pid	Number		4
algo_id	Number		1301	+1
sens_column	Array
user	String		123
table	String		123
column	String		123
algo_arg	Array			3
name	Array		["偏移量","长度","屏蔽字符"]	+1
key	Array		["off","len","val"]	+1
value	Array		["1","0","*"]	+1
setted	Number		1	+1
type	Array		["int","int","string"]	+1
sens_map_id	Array		["1","2"]	+1
algo_name	Array		["屏蔽姓名","屏蔽身份证出生月日"]	+1
sens_type_name	Array		["姓名","身份证号"]	+1
full_sync_settings	Object
his_thread	Number		1
full_sync_obj_filter	Array		["INDEX","VIEW","FUNCTION","PROCEDURE","PACKAGE","PACKAGE BODY","SYNONYM","TRIGGER","SEQUENCE","JAVA CLASS","TYPE","TYPE BODY","MATERIALIZED VIEW","OLD JOB","JOB","PRIVS","CONSTRAINT","JAVA RESOURCE","JAVA SOURCE"]
inc_sync_ddl_filter	Null
filter_table_settings	Null
etl_settings	Null
create_time	Number		1601345043
start_rule_now	Number		1
db_map_uuid	String		71D59BCE-17F3-ED0D-BC76-132833F72498
dml_track	String
kafka_time_out	String		12000
part_load_balance	String		by_key
kafka_message_encoding	String		UTF-8
kafka	String
biz_grp_list	Array
biz_grp_name	Array	是
modify	Boolean		1
_	String		4d058aa7a4ce1

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String

脱敏规则审批

SDK方法名：createApprove

URL

/mask/rule/approve

Method

POST

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String

脱敏规则 - 导入脱敏文件配置

SDK方法名：importMaskRuleInfo

URL

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

Method

POST

Request

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

Response

名称	类型	Mock初始值
ret	String	0
msg	String	success
data	Object
map_type	String
table_map	String
db_user_map	String
etl_settings	Object
etl_table	Array
deal_type	String
field_condition	String
obj_fix_type	String
table	String
user	String
code	String
message	String

数据脱敏

# 数据脱敏

# ------敏感类型-------

# URL

# Method

# Request

# Response

# 敏感类型列表

# URL

# Method

# Request

# Response

# 获取总览列表

# URL

# Method

# Request

# Response

# 修改敏感类型

# URL

# Method

# Request

# Response

# 获取单个类型

# URL

# Method

# Request

# Response

# ------- 脱敏算法-------

# URL

# Method

# Request

# Response

# 新建脱敏算法

# URL

# Method

# Request

# Response

# 脱敏算法列表

# URL

# Method

# Request

# Response

# 获取单个算法

# URL

# Method

# Request

# Response

# ------ 脱敏规则------

# URL

# Method

# Request

# Response

# 脱敏规则列表

# URL

# Method

# Request

# Response

# 新建脱敏规则

# URL

# Method

# Request

# Response

# 操作脱敏规则

# URL

# Method

# Request

# Response

# 删除脱敏规则

# URL

# Method

# Request

# Response

# 获取单条脱敏规则

# URL

# Method

# Request

# Response

# 获取脱敏状态

# URL

# Method

数据脱敏

------敏感类型-------

URL

Method

Request

Response

敏感类型列表

URL

Method

Request

Response

获取总览列表

URL

Method

Request

Response

修改敏感类型

URL

Method

Request

Response

获取单个类型

URL

Method

Request

Response

------- 脱敏算法-------

URL

Method

Request

Response

新建脱敏算法

URL

Method

Request

Response

脱敏算法列表

URL

Method

Request

Response

获取单个算法

URL

Method

Request

Response

------ 脱敏规则------

URL

Method

Request

Response

脱敏规则列表

URL

Method

Request

Response

新建脱敏规则

URL

Method

Request

Response

操作脱敏规则

URL

Method

Request

Response

删除脱敏规则

URL

Method

Request

Response

获取单条脱敏规则

URL

Method

Request

Response

获取脱敏状态

URL

Method

Request