创建脱敏模板 - CreateMaskTemplate
功能介绍
功能介绍:创建脱敏模板,配置模板名称、描述、扫描模板及规则列表(扫描规则与脱敏规则ID),创建后可用于批量脱敏任务。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/mask/mask-algorithm-templates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 脱敏模板名称 约束限制: 4~512个字符,满足正则匹配"^[\u4e00-\u9fa5A-Za-z][\u4e00-\u9fa5A-Za-z0-9_-.]*$" 取值范围: 不涉及 默认取值: 不涉及 |
| description | 否 | String | 参数解释: 资源描述信息 约束限制: 最大长度512字符 取值范围: 不涉及 默认取值: 不涉及 |
| scan_template_id | 是 | String | 参数解释: 扫描模板ID,标识一个扫描模板,用于指定脱敏模板关联的扫描模板。扫描模板ID可通过查询扫描模板列表接口获取。 约束限制: 最大长度32字符 取值范围: 不涉及 默认取值: 不涉及 |
| rules | 是 | Array of TemplateRuleItem objects | 参数解释: 脱敏规则列表,数组中的每个元素为一个脱敏规则项,用于指定脱敏模板包含的脱敏扫描规则,元素为规则名称字符串,需与脱敏模板下已配置的规则一致。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求示例
创建脱敏模板
{
"name" : "mask-template-01",
"description" : "客户敏感字段脱敏模板",
"scan_template_id" : "1a2b3c4d5e6f4a7b8c9d0e1f2a3b4c5d",
"rules" : [ {
"scan_rule_id" : "scan-rule-01",
"mask_rule_id" : "mask-rule-01"
}, {
"scan_rule_id" : "scan-rule-02",
"mask_rule_id" : "mask-rule-02"
} ]
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "创建脱敏模板成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建脱敏模板成功 |
错误码
请参见错误码。