根据字段类型与算法类型获取算法列表 - ListAlgorithms
功能介绍
根据字段类型与算法类型获取算法列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/server/mask/algorithms
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| algorithm_type | 是 | String | 参数解释: 算法类型,用于指定查询的脱敏算法类型,以筛选并返回符合条件的脱敏算法列表。算法类型可通过调用「查询脱敏算法类型列表」接口获取,或在数据安全中心控制台脱敏算法页面查看。 约束限制: 不涉及 取值范围: 字符串类型,长度1~256字符,取值例如哈希脱敏、加密脱敏、置空脱敏、伪造脱敏等脱敏算法类别 默认取值: 不涉及 |
| field | 否 | String | 参数解释: 字段信息,用于指定查询的字段名称或字段类型,以筛选脱敏算法列表,返回可用于该字段脱敏的算法。 约束限制: 非必填,可与算法类型参数组合使用增加筛选条件 取值范围: 字符串类型,长度1~256字符,填写字段名称或字段类型标识 默认取值: 不涉及 |
| db_type | 否 | String | 参数解释: 数据库类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Long | 参数解释: 总记录数 取值范围: 不涉及 |
| algorithms | Array of Algorithm objects | 参数解释: 算法列表,数组中的每个元素为一条脱敏算法记录,包含算法ID、算法名称、算法类型、参数、类别、脱敏前后数据等信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| algorithm_id | String | 参数解释: 脱敏算法ID 取值范围: 不涉及 |
| algorithm_name | String | 参数解释: 算法名称 取值范围: 不涉及 |
| algorithm_name_en | String | 参数解释: 算法英文名称 取值范围: 不涉及 |
| algorithm | String | 参数解释: 脱敏算法,标识该脱敏记录所采用的脱敏算法 取值范围: |
| parameter | String | 参数解释: 算法参数,表示算法列表项中该脱敏算法所需的配置参数内容,如密钥长度、替换规则等,为一串配置参数文本。 取值范围: 字符串类型,长度0~1024字符 |
| category | String | 参数解释: 算法类别,标识脱敏算法的类别归属 取值范围: |
| data | String | 参数解释: 待脱敏原始数据,表示用于脱敏算法处理或预览脱敏效果的原始数据内容 取值范围: 不涉及 |
| processed_data | String | 参数解释: 脱敏后处理数据,表示原始数据经脱敏算法处理后的结果数据 取值范围: 不涉及 |
请求示例
根据字段类型与算法类型获取算法列表
/v1/2b31ed520abcd1234ebedb6e57123456/sdg/server/mask/algorithms?algorithm_type=MASK_BY_HASH
响应示例
状态码:200
{
"total" : 1,
"algorithms" : [ {
"algorithm_id" : "550e8400-e29b-41d4-a716-446655440000",
"algorithm_name" : "MASK",
"algorithm" : "MASK_BY_HASH",
"parameter" : "{\"type\":\"RAND\",\"first\":3,\"second\":4,\"method\":\"CHAR\"}",
"category" : "BUILT_IN",
"data" : "13812345678",
"processed_data" : "138****5678"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。