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

添加或更新新的算法 - CreateAlgorithms

功能介绍

添加或更新新的算法

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/server/mask/algorithms

表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_id

否

String

参数解释:

算法ID,标识要更新的已有脱敏算法,新增算法时可不传,更新时必传,可通过调用查询算法列表接口获取

约束限制:

符合UUID

取值范围:

不涉及

默认取值:

不涉及

algorithm_name

是

String

参数解释:

算法名称

约束限制:

最大长度256字符

取值范围:

不涉及

默认取值:

不涉及

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

是

String

参数解释:

脱敏算法的具体表达式或配置内容,用于定义脱敏规则的具体实现

约束限制:

不涉及

取值范围:

  • SHA256:SHA-256哈希脱敏

  • SHA512:SHA-512哈希脱敏

  • MASKNM:掩盖前N后M位

  • PRESNM:保留前N后M位

  • MASKXY:掩盖第X到Y位

  • PRESXY:保留第X到Y位

  • SYMBOL:符号替换

  • KEYWORD:关键字替换

  • NULL:置空

  • EMPTY:置空为空字符串

  • DATE:日期泛化

  • NUMERIC:数值泛化

  • AES:AES加密脱敏

  • SM4:SM4加密脱敏

  • DECRYPT:解密脱敏

  • FAKE:伪数据生成

默认取值:

不涉及

parameter

是

String

参数解释:

脱敏算法的配置参数,用于传递脱敏算法运行所需的输入参数,格式为JSON字符串

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

category

是

String

参数解释:

类别

约束限制:

不涉及

取值范围:

BUILT_IN-内置,BUILT_IN_COPY-内置复制,BUILT_SELF-自定义

默认取值:

不涉及

data

否

String

参数解释:

原始数据样本,用于测试脱敏算法效果的原始数据,算法处理后返回脱敏结果供预览验证

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

processed_data

否

String

参数解释:

脱敏后样例数据

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

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

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

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

取值范围:

不涉及

请求示例

添加或更新新的算法

{
  "algorithm_id" : "550e8400-e29b-41d4-a716-446655440000",
  "algorithm_name" : "MASK",
  "algorithm_type" : "MASK_BY_HASH",
  "algorithm" : "MASK_BY_HASH",
  "parameter" : "{\"type\":\"RAND\",\"first\":3,\"second\":4,\"method\":\"CHAR\"}",
  "category" : "BUILT_IN",
  "data" : "13812345678",
  "processed_data" : "138****5678"
}

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "添加或更新新的算法成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

更新成功

错误码

请参见错误码。

相关文档