脚本脱敏 February 26, 2024 About 8 min 脚本脱敏 SDK类名：/active/ScriptMask
示例接口 示例接口描述
URL Method 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
----脚本管理----- URL Method Request Response 增加脚本 SDK方法名：createScript
URL Method Request 名称 类型 必选 简介 Mock初始值 Mock规则 script_name String 脚本名称 script_type Number 脚本类型：SQL脚本：0，shell脚本：1 config Object desc String 描述 script String 脚本
Response 名称 类型 必选 简介 Mock初始值 Mock规则 ret Number 200 msg String data Object code Number 0 message String success
修改脚本 SDK方法名：modifyScript;
URL /mask/script/:uuid([A-F0-9-]+)
Method Request 名称 类型 必选 简介 Mock初始值 Mock规则 script_name String 脚本名称 script_type Number 脚本类型：SQL脚本：0，shell脚本：1 config Object desc String 描述 script String 脚本
Response 名称 类型 必选 简介 Mock初始值 Mock规则 ret Number 200 msg String data Object code Number 0 message String success
删除脚本 SDK方法名：deleteScript
URL Method Request 名称 类型 必选 简介 Mock初始值 Mock规则 uuids String
Response 名称 类型 必选 简介 Mock初始值 Mock规则 ret Number 200 msg String data Object code Number 0 message String success
获取脚本列表 SDK方法名：listScript
URL Method 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 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 total Number 2
获取脚本详细信息 SDK方法名：descriptScript
URL Method Request 名称 类型 必选 简介 Mock初始值 Mock规则 uuid String
Response 名称 类型 必选 简介 Mock初始值 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 val1, @'val2', @ghttps://codemirror.net/mode/sql/index.html?mime=text/x-sqllobal.'sql_mode', float_val, .14 AS another_float, 0.09e3 AS int_with_esp, hex, x'fa5' AS hex2, 0b101 AS bin, b'101' AS bin2, sql_date, { T "1994-01-01" } AS odbc_date, desc String test-2 create_time String 1592810073
-----脱敏规则----- URL Method Request Response 增加规则 SDK方法名：createRule
URL Method 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初始值 Mock规则 ret Number 200 msg String data Object code Number 0 message String success
增加规则副本 SDK方法名：modifyScriptRule
URL Method 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初始值 Mock规则 ret Number 200 msg String data Object code Number 0 message String success
删除规则 SDK方法名：deleteRule
URL Method Request 名称 类型 必选 简介 Mock初始值 Mock规则 uuids String 是 force Boolean true
Response 名称 类型 必选 简介 Mock初始值 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 Method Request 名称 类型 必选 简介 Mock初始值 Mock规则 limit Number 10 page Number 1 search_field String rule_name search_value String
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 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 Method 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
URL /mask/script_rule/status_detail/:uuid([A-F0-9-]+)
Method Request Response 名称 类型 必选 简介 Mock初始值 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 结束时间
获取规则状态 SDK方法名：listRuleStatus
URL Method Request 名称 类型 必选 简介 Mock初始值 Mock规则 uuids Array
Response 名称 类型 必选 简介 Mock初始值 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 Request 名称 类型 必选 简介 Mock初始值 Mock规则 operate String stop uuids Array
Response 名称 类型 必选 简介 Mock初始值 Mock规则 ret Number 200 msg String data Object code Number 0 message String
