更新时间:2024-03-29 GMT+08:00

对数据进行脱敏

功能介绍

对数据进行脱敏

URI

POST /v1/{project_id}/data/mask

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务“获取用户Token接口”获取(响应消息头中X-Subject-Token的值)

表3 请求Body参数

参数

是否必选

参数类型

描述

mask_strategies

Array of MaskStrategies objects

脱敏策略列表,每一个策略对应一个字段,脱敏策略数最多100个。

data

Array of Map<String,Object> objects

数据列表。

表4 MaskStrategies

参数

是否必选

参数类型

描述

name

String

需要脱敏的字段名称,最大支持长度256。

algorithm

String

脱敏算法名称,详情见附录"动态脱敏策略配置"。

枚举值:

  • SHA256

  • SHA512

  • AES

  • PRESNM

  • MASKNM

  • PRESXY

  • MASKXY

  • SYMBOL

  • KEYWORD

  • NUMERIC

parameters

Map<String,Object>

脱敏算法参数,详情见附录"动态脱敏策略配置"。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

masked_data

Array of Map<String,Object> objects

脱敏后的数据的数据列表,结构与请求中结构相同

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

脱敏策略列表中对字段col使用KEYWORD脱敏算法,将指定关键字keyword替换为target。

POST https://{endpoint}/v1/{project_id}/data/mask

{
  "mask_strategies" : {
    "name" : "col",
    "algorithm" : "KEYWORD",
    "parameters" : {
      "key" : "keyword",
      "target" : "target"
    }
  },
  "data" : {
    "col" : "keyword"
  }
}

响应示例

状态码: 200

脱敏成功

{
  "masked_data" : [ {
    "col" : "target"
  } ]
}

状态码: 400

无效请求

{
  "error_code" : "DSC.00000004",
  "error_msg" : "Invalid parameter"
}

状态码

状态码

描述

200

脱敏成功

400

无效请求

错误码

请参见错误码