# 获取字段与算法的映射关系 - CreateFieldAlgorithmsMappings #### 功能介绍 获取字段与算法的映射关系 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v1/{project_id}/sdg/server/mask/algorithms/field-algorithms-mappings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"\^\[a-z0-9\]{32}$" **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | db_type | 否 | String | **参数解释：** 数据库类型 **约束限制：** 最大长度1024字符 **取值范围：** 不涉及 **默认取值：** 不涉及 | | fields | 否 | Array of strings | **参数解释：** 字段列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | rule_fields | 否 | Array of strings | **参数解释：** 规则fields **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | field | String | **参数解释：** 字段名称 **取值范围：** 不涉及 | | algorithm_types | Array of strings | **参数解释：** 脱敏算法类型列表 **取值范围：** 不涉及 | | algorithms | Array of strings | **参数解释：** 脱敏算法列表 **取值范围：** 不涉及 | | rule_id | String | **参数解释：** 字段算法响应ID **取值范围：** 不涉及 | | algorithm_id | String | **参数解释：** 脱敏算法ID **取值范围：** 不涉及 | | algorithm_type | String | **参数解释：** 算法类型 **取值范围：** - MASK_BY_HASH-哈希脱敏 - MASK_BY_ENCRYPT-加密脱敏 - MASK_BY_OVERWRITE-覆写脱敏 - MASK_BY_KEYWORDS_EXCHANGE-关键词替换 - MASK_BY_NULL-置空脱敏 - MASK_BY_BRIEF-简写脱敏 - MASK_BY_DECRYPT-解密脱敏 - MASK_BY_FAKE-伪造脱敏 | | algorithm_type_old | String | **参数解释：** 历史脱敏算法类型 **取值范围：** 不涉及 | | field_algorithms | Array of [FieldAlgorithms] objects | **参数解释：** 字段与脱敏算法映射列表 **取值范围：** 不涉及 | | rule_algorithms | Array of [RuleMaskAlgorithm] objects | **参数解释：** 规则与脱敏算法映射列表 **取值范围：** 不涉及 | 表5FieldAlgorithms | 参数 | 参数类型 | 描述 | |:---|:---|:---| | field | String | **参数解释：** 字段名 **取值范围：** 不涉及 | | algorithm_types | Array of strings | **参数解释：** 算法类型列表 **取值范围：** 不涉及 | | algorithms | Array of strings | **参数解释：** 算法ID列表 **取值范围：** 不涉及 | 表6RuleMaskAlgorithm | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rule_id | String | **参数解释：** 规则脱敏算法ID **取值范围：** 不涉及 | | algorithm_id | String | **参数解释：** 脱敏算法ID **取值范围：** 不涉及 | | algorithm_type | String | **参数解释：** 算法类型 **取值范围：** 不涉及 | #### 请求示例 获取字段与算法的映射关系 ``` { "db_type" : "default-value", "fields" : [ "example-value" ], "rule_fields" : [ "rule-xxxx" ] } ``` #### 响应示例 **状态码：200** ``` { "field" : "customer_phone", "algorithm_types" : [ "MASK_BY_HASH" ], "algorithms" : [ "SHA256" ], "rule_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "algorithm_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "algorithm_type" : "MASK_BY_HASH", "algorithm_type_old" : "MASK_BY_HASH", "field_algorithms" : [ { "field" : "customer_phone", "algorithm_types" : [ "MASK_BY_HASH" ], "algorithms" : [ "SHA256" ] } ], "rule_algorithms" : [ { "rule_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "algorithm_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "algorithm_type" : "MASK_BY_HASH" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。