文档首页/ 数据安全中心 DSC/ API参考/ API/ 脱敏算法/ 添加加密脱敏配置 - CreateEncryptionConfigurations
更新时间:2026-11-13 GMT+08:00
分享

添加加密脱敏配置 - CreateEncryptionConfigurations

功能介绍

添加加密脱敏配置

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/server/mask/algorithms/encryption-configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

algorithm_type

是

String

参数解释:

算法类型,指定加密脱敏所采用的算法类型

约束限制:

不涉及

取值范围:

  • SHA256:SHA256哈希脱敏

  • SHA512:SHA512哈希脱敏

  • PRESNM:保留脱敏

  • MASKNM:掩码脱敏

  • PRESXY:保留XY坐标脱敏

  • MASKXY:掩码XY坐标脱敏

  • SYMBOL:符号覆写脱敏

  • KEYWORD:关键字替换脱敏

  • NULL:置空脱敏

  • EMPTY:置空脱敏

  • DATE:日期概要脱敏

  • NUMERIC:数值概要脱敏

  • AES:AES加密脱敏

  • EMBED:嵌入水印

  • SM4:SM4国密加密脱敏

  • FAKE:伪造数据脱敏

  • DECRYPT:解密脱敏

默认取值:

不涉及

algorithm_name

否

String

参数解释:

算法名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

encrypt_mode

是

String

参数解释:

加密模式

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

filling_method

是

String

参数解释:

填充方法

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

kms_context

否

KmsContext object

参数解释:

KMS上下文

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

rotate_period

否

Integer

参数解释:

密钥轮转周期,标识加密密钥自动轮换的时间间隔,单位为天

约束限制:

取值上限为2147483647

取值范围:

不涉及

默认取值:

不涉及

key_len

否

Integer

参数解释:

密钥长度,标识加解密所用密钥的位长度,单位bit

约束限制:

取值上限为2147483647

取值范围:

不涉及

默认取值:

不涉及

表4 KmsContext

参数

是否必选

参数类型

描述

kms_region

否

String

参数解释:

KMS区域

约束限制:

最大长度64字符

取值范围:

不涉及

默认取值:

不涉及

kms_key_alias

否

String

参数解释:

KMS密钥别名

约束限制:

最大长度128字符

取值范围:

不涉及

默认取值:

不涉及

kms_key_id

否

String

参数解释:

KMS密钥ID,标识KMS中用于加密的密钥,可通过KMS服务控制台密钥管理页面或调用KMS查询密钥列表接口获取

约束限制:

最大长度128字符

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求处理状态,标识任务的执行结果

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

被删除的水印嵌入任务对应的资源ID

取值范围:

不涉及

请求示例

添加加密脱敏配置

{
  "algorithm_type" : "SHA256",
  "algorithm_name" : "algorithm-finance-01",
  "encrypt_mode" : "default",
  "filling_method" : "GET",
  "kms_context" : { },
  "rotate_period" : 1,
  "key_len" : 1
}

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "添加加密脱敏配置成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

添加加密脱敏配置成功

错误码

请参见错误码。

相关文档