获取字段与算法的映射关系 - ListFieldAlgorithms

功能介绍

根据数据库类型查询字段与算法的映射关系

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/sdg/server/mask/algorithms/field-algorithms-mappings

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目唯一标识符

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
db_type	否	String	数据库类型,可选类型：MySQL、PostgreSQL、HBase、OpenGauss、Oracle、SQLServer、MongoDB、DWS、KingBase、GreenPlum、DMDBMS、Hive、TDSQL、HIVE_ONLY、DLI、Elasticsearch、MRS_HIVE、OBS。
fields	否	Array of strings	需要脱敏的字段列表
rule_fields	否	Array of strings	字段对应的扫描规则。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
field_algorithms	Array of FieldAlgorithms objects	字段对应的脱敏算法列表
rule_algorithms	Array of RuleMaskAlgorithm objects	规则对应的脱敏算法列表

表4 FieldAlgorithms
参数	参数类型	描述
algorithm_types	Array of strings	支持的脱敏算法类型列表，包括：MASK_BY_HASH、MASK_BY_ENCRYPT、MASK_BY_OVERWRITE、MASK_BY_KEYWORDS_EXCHANGE、MASK_BY_NULL、MASK_BY。
algorithms	Array of strings	支持的脱敏算法标识符列表，包括：SHA256、SHA512、PRESNM、MASKNM、PRESXY、MASKXY、SYMBOL、KEYWORD、NULL、EMPTY、DATE、NUMERIC、AES、EMBED、SM4、DECRYPT。
field	String	需要脱敏的字段名称

表5 RuleMaskAlgorithm
参数	参数类型	描述
algorithm_type	String	脱敏算法的类型，包括：MASK_BY_HASH、MASK_BY_ENCRYPT、MASK_BY_OVERWRITE、MASK_BY_KEYWORDS_EXCHANGE、MASK_BY_NULL、MASK_BY。
algorithm_id	String	脱敏算法的唯一ID
rule_id	String	脱敏规则的唯一ID

状态码：201

资源创建

请求示例

POST /v1/{project_id}/sdg/server/mask/algorithms/field-algorithms-mappings

{
  "db_type" : "string",
  "fields" : [ "string" ],
  "rule_fields" : [ "string" ]
}