A.4.1 SHA256/512
该算法将指定字段的内容用其SHA256/SHA512的摘要值代替。
请求参数
表A-1 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，SHA256/
SHA512
parameters 是 Object 参数，该算法无参数可忽略
请求样例
{"mask_strategies": [ {"name": "col1",
"algorithm": "SHA256",
"parameters": {}
}],
"data": [ {"col1": "test"
]}
A.4.2 AES
将目标字符串使用AES算法进行加密。
AES算法参数配置如下：初始向量IV为16字节随机数，加密模式为GCM模式，填充方 式为PKCS7-Padding（即CMS-Padding）。
加密脱敏的密文中，前16字节存放IV值，后续为对应的密文内容。加密密文为二进 制，脱敏引擎输入的密文经过Base64编码，以字符串的形式存储在数据库中。
请求参数
表A-2 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，AES
参数 是否必选 参数类型 描述 parameters 是
parameters
Object 脱敏算法参数
表A-3 parameters 参数
参数 是否必选 参数类型 描述
key 是 String AES算法密钥
len 是 String 分组长度，目前取值仅支持
128，192，256
请求样例
{"mask_strategies": [ {"name": "col1",
"algorithm": "AES",
"parameters": {
"key": "df643533b90b6926c9bff63cc16173db",
"len": "128"
}} ],"data": [ {"col1": "test"
}] }
A.4.3 PRESNM
对目标字符串保留前n位和后m位，对中间部分内容掩盖。
请求参数
表A-4 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，PRESNM parameters 是
parameters
Object 脱敏算法参数
表A-5 parameters
method 是 String 掩盖参数，若type字段为
“RAND”时，method取 值只能为：
● CHAR：替换为字母
● DIGITAL：替换为数字
● BOTH：数字与字母混合
"mask_strategies": [ {
] }
A.4.4 MASKNM
对目标字符串掩盖前n位和后m位，对中间部分内容保留。
请求参数
表A-6 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，MASKNM parameters 是
parameters
Object 脱敏算法参数
表A-7 parameters
参数 是否必选 参数类型 描述
type 是 String 掩盖字符串的方式，取值
为：
● CHAR：字符掩盖
● RAND：随机掩盖
method 是 String 掩盖参数，若type字段为
“RAND”时，method取 值只能为：
● CHAR：替换为字母
● DIGITAL：替换为数字
● BOTH：数字与字母混合 替换
n 是 Int 掩盖前n位字符
m 是 Int 掩盖后m位字符
请求样例
{ "mask_strategies": [ {
"name": "col1",
"algorithm": "MASKNM", "parameters": {
"type": "CHAR", "n": 1,
"m": 1, "method": "*"
} }
],
"mask_strategies": [ {
A.4.5 PRESXY
保留目标字符串x至y的内容，其他部分内容掩盖。
请求参数
表A-8 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，PRESXY parameters 是
parameters
Object 脱敏算法参数
表A-9 parameters
参数 是否必选 参数类型 描述
type 是 String 掩盖字符串的方式，取值
为：
● CHAR：字符掩盖
● RAND：随机掩盖
参数 是否必选 参数类型 描述
method 是 String 掩盖参数，若type字段为
“RAND”时，method取 值只能为：
● CHAR：替换为字母
● DIGITAL：替换为数字
● BOTH：数字与字母混合
"mask_strategies": [ {
A.4.6 MASKXY
掩盖字符串x至y的内容，其他部分内容保留。
请求参数
表A-10 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，MASKXY parameters 是
parameters
Object 脱敏算法参数
表A-11 parameters
参数 是否必选 参数类型 描述
type 是 String 掩盖字符串的方式，取值
为：
● CHAR：字符掩盖
● RAND：随机掩盖
method 是 String 掩盖参数，若type字段为
“RAND”时，method取 值只能为：
● CHAR：替换为字母
● DIGITAL：替换为数字
● BOTH：数字与字母混合
"mask_strategies": [
A.4.7 SYMBOL
对特殊符号前或后的内容掩盖，另一部分内容保留。
请求参数
表A-12 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，SYMBOL parameters 是
parameters
Object 脱敏算法参数
表A-13 parameters
参数 是否必选 参数类型 描述
type 是 String 掩盖字符串的方式，取值
为：
● CHAR：字符掩盖
● RAND：随机掩盖
method 是 String 掩盖参数，若type字段为
“RAND”时，method取 值只能为：
● CHAR：替换为字母
● DIGITAL：替换为数字
● BOTH：数字与字母混合 替换
direction 是 Int 掩盖的方向
0：特殊字符前掩盖 1：特殊字符后掩盖
参数 是否必选 参数类型 描述
symbol 是 String 指定的特殊字符
请求样例
"mask_strategies": [ {
A.4.8 KEYWORD
对目标字符串中的指定关键词进行替换。
请求参数
表A-14 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，KEYWORD parameters 是
parameters
Object 脱敏算法参数
表A-15 parameters
参数 是否必选 参数类型 描述
key 是 String 指定的关键词
target 是 String 替换后的目标值
请求样例
{ "mask_strategies": [ {
"name": "col1",
"algorithm": "KEYWORD", "parameters": {
"key": "关键字", "target": "目标字符串"
} } ], "data": [ {
"col1": "关键字"
} ] }
A.4.9 NUMERIC
对数值型字段向下泛化。
请求参数
表A-16 请求参数
参数 是否必选 参数类型 描述
algorithm 是 String 算法类型，NUMERIC parameters 是
parameters
Object 脱敏算法参数
表A-17 parameters
参数 是否必选 参数类型 描述
value 是 Double 指定数据类需要泛化的区间
范围值，只能为整数或者小 数，且必须大于0
请求样例
{ "mask_strategies": [
{
"name": "col1",
"algorithm": " NUMERIC", "parameters": {
"value": 0.05 }
} ], "data": [ {
"col1": "test"
} ] }
B 修订记录
发布日期 修改说明
2021-12-13 第十一次正式发布。
更新“嵌入文档水印”接口。
2021-11-10 第十次发布。
● 修改终端节点章节。
● 增加敏感数据相关接口。
2021-09-28 第九次正式发布。
API按规范优化。
2021-09-14 第八次正式发布。
修改终端节点章节。
2021-09-09 第七次正式发布。
修改约束与限制，增加水印的约束限制。
2021-07-22 第六次正式发布。
API优化。
2021-04-28 第五次正式发布。
API接口按规范整改。
2021-04-16 第四次正式发布。
错误码按规范整改。
2021-04-07 第三次正式发布。
增加“图片水印”章节。
2021-03-11 第二次正式发布。
修改“图片水印”章节，支持PPT文件添加水 印。
2020-11-24 第一次正式发布。