算法测试,返回脱敏结果 - CreateMaskAlgorithmTest
功能介绍
算法测试,返回脱敏结果
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/server/mask/algorithms/test
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| algorithm_id | 否 | String | 参数解释: 算法ID,标识一个脱敏算法,用于指定算法测试所使用的目标算法。算法ID可通过查询脱敏算法列表接口(查询算法列表)获取,或通过查询算法详情接口获取。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| algorithm_name | 否 | String | 参数解释: 算法名称,标识一个脱敏算法的名称,用于算法测试时展示所使用算法的名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 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 | 参数解释: 脱敏算法,指定算法测试所使用的脱敏算法标识。算法ID可通过查询脱敏算法列表接口获取,或通过查询算法详情接口获取。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| parameter | 否 | String | 参数解释: 脱敏算法的配置参数,用于指定脱敏算法的具体配置项,如脱敏长度、关键字替换内容等,按所选算法的要求填写。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| category | 否 | String | 参数解释: 类别 约束限制: 不涉及 取值范围: BUILT_IN-内置,BUILT_IN_COPY-内置复制,BUILT_SELF-自定义 默认取值: 不涉及 |
| data | 否 | String | 参数解释: 待脱敏的原始数据,用于算法测试时输入的原始文本内容,算法将对该数据进行脱敏处理并返回脱敏结果。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| processed_data | 否 | String | 参数解释: 脱敏后数据 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| processed_data | String | 参数解释: 脱敏后处理数据 取值范围: 不涉及 |
请求示例
算法测试,返回脱敏结果
{
"algorithm_id" : "0b02392f3d0042bd8f80376485d9b7d8",
"algorithm_name" : "algorithm-finance-01",
"algorithm_type" : "MASK_BY_HASH",
"algorithm" : "SHA256",
"parameter" : "param-value",
"category" : "BUILT_IN",
"data" : "example-data",
"processed_data" : "example-value"
} 响应示例
状态码:200
{
"processed_data" : "138****8000"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 算法测试,返回脱敏结果成功 |
错误码
请参见错误码。