脚本脱敏

February 26, 2024About 9 min

脚本脱敏

SDK类名：/active/ScriptMask

----脚本管理-----

URL

Method

GET

Request

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

Response

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

增加脚本

SDK方法名：createScript

URL

/mask/script

Method

POST

Request

名称	类型	简介
script_name	String	脚本名称
script_type	Number	脚本类型：SQL脚本：0，shell脚本：1
config	Object
desc	String	描述
script	String	脚本

Response

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

修改脚本

SDK方法名：modifyScript;

URL

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

Method

PUT

Request

名称	类型	简介
script_name	String	脚本名称
script_type	Number	脚本类型：SQL脚本：0，shell脚本：1
config	Object
desc	String	描述
script	String	脚本

Response

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

删除脚本

SDK方法名：deleteScript

URL

/mask/script

Method

DELETE

Request

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

Response

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

获取脚本列表

SDK方法名：listScript

URL

/mask/script

Method

GET

Request

名称	类型	简介	Mock初始值
page	Number		1
limit	Number		10
search_field	String
search_value	String
like_args	Array	条件模糊查询
mask_node_name	String	执行节点名
rule_name	String	规则名称
search_script_name	String	脚本名称

Response

名称	类型	简介	Mock初始值	Mock规则
ret	Number		200
msg	String
data	Object
code	Number		0
message	String		[0] 操作成功。
info_list	Array			2
username	String		admin
user_uuid	String		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
script_uuid	Array		["CA0F1675-945E-2747-9115-73FC973B2487","000CC79A-6702-65C0-9B7F-368D2D647273"]	+1
script_name	Array		["1231231","123"]	+1
config	Object
script	Array		["12312313221","12123"]	+1
desc	String		123
create_time	Array		["1601360218","1600828736"]	+1
relevant_rules	String	关联规则（备份中心）
total	Number		2

下载脚本

SDK方法名：downloadScript；

URL

/mask/script/download

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
version_id	String		历史版本号

Response

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

获取脚本详细信息

SDK方法名：descriptScript

URL

/mask/script/:id

Method

GET

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
script	Object
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
script_uuid	String	486AE75B-A92F-17C1-637D-D190F3C66EEA
script_name	String	test-2
config	Object
script	String	-- SQL Mode for CodeMirror SELECT SQL_NO_CACHE DISTINCT @var1 AS `val1`, @'val2', @ghttps://codemirror.net/mode/sql/index.html?mime=text/x-sqllobal.'sql_mode', 1.1 AS `float_val`, .14 AS `another_float`, 0.09e3 AS `int_with_esp`, 0xFA5 AS `hex`, x'fa5' AS `hex2`, 0b101 AS `bin`, b'101' AS `bin2`, DATE '1994-01-01' AS `sql_date`, { T "1994-01-01" } AS `odbc_date`, 'my string', _utf8'your string', N'her string', TRUE, FALSE, UNKNOWN FROM DUAL -- space needed after '--' # 1 line comment /* multiline comment! */ LIMIT 1 OFFSET 0;
desc	String	test-2
create_time	String	1592810073

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

URL

Method

GET

Request

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

Response

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

增加规则

SDK方法名：createRule

URL

/mask/script_rule

Method

POST

Request

名称	类型	简介	Mock初始值	Mock规则
rule_name	String	规则名
node_uuid	String	执行节点uuid（shell类型脚本）
src_db_uuid	String	执行节点uuid（sql类型脚本）
config	Object
script	Array	脚本UUID列表
script_type	Number	脚本类型，0：SQL脚本，1：shell脚本		0-1
src_type	String
dyn_thd	Number	线程数	1
lderrset	String	发生错误后处理	continue

Response

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

增加规则副本

SDK方法名：modifyScriptRule

URL

/mask/script_rule

Method

PUT

Request

名称	类型	简介	Mock初始值	Mock规则
rule_name	String	规则名
node_uuid	String	执行节点uuid（shell类型脚本）
src_db_uuid	String	执行节点uuid（sql类型脚本）
config	Object
script	Array	脚本UUID列表
script_type	Number	脚本类型，0：SQL脚本，1：shell脚本		0-1
src_type	String
dyn_thd	Number	线程数	1
lderrset	String	发生错误后处理	continue

Response

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

删除规则

SDK方法名：deleteRule

URL

/mask/script_rule

Method

DELETE

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
data	Object
code	Number	-1
message	String	ERROR
fail_list	Array
code	Number	-1
message	String	[-1] 找不到节点
rule_name	String	123
rule_uuid	String	1D9e4d3f-3BcB-4F48-D0cA-AbE0Bf8BD111

获取规则列表

SDK方法名：listRules

URL

/mask/script_rule

Method

GET

Request

名称	类型	Mock初始值
limit	Number	10
page	Number	1
search_field	String	rule_name
search_value	String

Response

名称	类型	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	Null
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	85A68844-0A42-EC01-C275-9B32639C1BC9
rule_name	String	123
src_db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
tgt_db_uuid	String
node_uuid	String	A6ABF8BC-38AF-41FE-ACF7-DD9F28B0FA3F
tgt_type	String
map_type	String
rule_type	Number	50
config	Object
script	Array	["000CC79A-6702-65C0-9B7F-368D2D647273"]
src_type	String	oracle
dyn_thd	Number	1
lderrset	String	continue
policy	Array
create_time	Number	1600828765
scripts	Array
script_name	String	123
script_uuid	String	000CC79A-6702-65C0-9B7F-368D2D647273
is_biz_admin	Number	1
can_del	Number	1
can_op	Number	1
can_up	Number	1
total	Number	1

获取规则详细信息

SDK方法名：descriptRule

URL

/mask/script_rule/:id

Method

GET

Request

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

Response

名称	类型	Mock初始值	Mock规则
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
script_rule	Object
username	String	admin
user_uuid	String	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
rule_uuid	String	37605A8B-9AE1-8485-27C2-ADDF08C0CE67
rule_name	String	1234
src_db_uuid	String	FE791296-42FE-43FC-F492-8EB7BA841C70
tgt_type	String
map_type	String
rule_type	Number	50
config	Object
script	Array	["74A003D5-0F08-F284-5920-D5F1D4286BE2","486AE75B-A92F-17C1-637D-D190F3C66EEA"]
src_type	String	oracle
dyn_thd	Number	1
lderrset	String	continue
policy	Object
policy_type	String	immediate
one_time	String
time_policy	String
create_time	Number	1592990608
node_uuid	String	B1A3F55A-027E-4B49-A4FA-D9ED9807ACBF
tgt_db_uuid	String
biz_grp_list	Array
biz_grp_name	Array
scripts	Array		2
script_name	Array	["test-2","update26"]	+1
script_uuid	Array	["486AE75B-A92F-17C1-637D-D190F3C66EEA","74A003D5-0F08-F284-5920-D5F1D4286BE2"]	+1
is_biz_admin	Number	1
can_del	Number	1
can_op	Number	1
can_up	Number	1

获取脚本执行结果

SDK方法名：getScriptRuleResultDetail

shell:


"info_list": [

  {

    "name": "for",

    "content": "for i in $(seq 1 1000)\ndo \n echo $i >> /tmp/test1/log.txt\n  sleep 0.5\ndone",

    "state": 0,

    "stage": "done",

    "start": true,

    "end": "2024-06-03 16:57:47",

    "msg": ""

  },

  {

    "name": "最后失败",

    "content": "touch /tmp/test1/touch1\nmkdir /tmp/test1",

    "state": -1,

    "stage": "abnormal",

    "start": true,

    "end": "2024-06-03 17:06:08",

    "msg": "mkdir: cannot create directory ‘/tmp/test1’: File exists\n"

  }

]

SQL:


"info_list": [

  {

    "name": "带$$存储过程",

    "progress": [

      {

        "content": "drop table if exists t_user;",

        "end": "2024-05-28 15:15:57",

        "line": 0,

        "msg": "",

        "stage": "done",

        "start": "2024-05-28 15:15:57",

        "state": 0

      },

      {

        "content": "create table table_test( a1 int primary key, a2 float, a3 varchar(10), a4 date, a5 text );",

        "end": "2024-05-28 15:15:57",

        "line": 0,

        "msg": "",

        "stage": "done",

        "start": "2024-05-28 15:15:57",

        "state": 0

      },

      {

        "content": "create procedure proc_test() begin insert into table_test values (1,3.14,\"zhangsan\",\"2019-11-29\",\"VMO info2soft\"); commit; end;",

        "end": "2024-05-28 15:15:57",

        "line": 0,

        "msg": "",

        "stage": "done",

        "start": "2024-05-28 15:15:57",

        "state": 0

      }

    ]

  }

]

URL

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

Method

GET

Request

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

Response

名称	类型	简介	Mock初始值
ret	String
msg	String
data	Object
info_list	Array
name	String	规则名
content	Array
content	String	SQL命令
state	Number	状态错误码（shell脚本时，0代表成功，其余代表失败）	0
stage	String	状态
line	String	sql影响行数
start	String	启动时间
stop	String	结束时间
msg	String	脚本执行结果

获取规则状态

SDK方法名：listRuleStatus

URL

/mask/script_rule/status

Method

GET

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
message	String	[0] 操作成功。
info_list	Array
mask_state	Object
status	String	ACTIVE_RULE_UNKNOWN
rule_uuid	String	85A68844-0A42-EC01-C275-9B32639C1BC9
src_db_uuid	String	38F1AD45-5F72-2E51-DC01-0593A14A8D17
tgt_db_uuid	String
node_uuid	String
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	Null
mask_node_info	Null

启/停规则

SDK方法名：operateRule

URL

/mask/script_rule/operate

Method

POST

Request

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

Response

名称	类型	Mock初始值
ret	Number	200
msg	String
data	Object
code	Number	0
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