根据project_id查找用户的加密脱敏配置信息 - ListAllEncryptionConfigurations
功能介绍
根据project_id查找用户的加密脱敏配置信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/server/mask/algorithms/encryption-configurations
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| algorithm_type | 是 | String | 参数解释: 算法类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 是 | Integer | 参数解释: 限制 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 是 | Integer | 参数解释: 偏移 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| configuration_name | 否 | String | 参数解释: 配置名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| access_permission | Boolean | 参数解释: 访问权限状态,标识当前用户是否拥有访问该加密脱敏配置的权限。 取值范围: true-有访问权限,false-无访问权限 |
| configuration_list | Array of EncryptConfigItem objects | 参数解释: 加密脱敏配置列表,数组中的每个元素为一条加密脱敏配置记录 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| algorithm_name | String | 参数解释: 加密脱敏算法名称 取值范围: 不涉及 |
| algorithm_type | String | 参数解释: 算法类型 取值范围: |
| configuration_name | String | 参数解释: 加密脱敏配置名称 取值范围: 不涉及 |
| encrypt_mode | String | 参数解释: 加密脱敏配置响应模式 取值范围: 不涉及 |
| filling_method | String | 参数解释: 加密脱敏配置响应方法 取值范围: 不涉及 |
| mask_task_num | Integer | 参数解释: 关联脱敏任务数量 取值范围: 不涉及 |
| kms_context | KmsContext object | 参数解释: 密钥管理服务上下文信息 取值范围: 不涉及 |
| rotate_period | Integer | 参数解释: 密钥轮转周期,表示加密密钥自动轮换的时间间隔,单位为天,用于控制密钥定期更换的频率。 取值范围: 整数,0~2147483647,单位为天 |
| enable_rotate | Boolean | 参数解释: 是否启用密钥轮转,标识该加密脱敏配置是否启用密钥的定期自动轮换。 取值范围: true-已启用密钥轮转,false-未启用密钥轮转 |
请求示例
根据project_id查找用户的加密脱敏配置信息
/v1/2b31ed520abcd1234ebedb6e57123456/sdg/server/mask/algorithms/encryption-configurations?algorithm_type=SHA256&limit=10&offset=0
响应示例
状态码:200
{
"total" : 1,
"access_permission" : true,
"configuration_list" : [ {
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
"algorithm_name" : "SHA256哈希脱敏算法",
"algorithm_type" : "SHA256",
"configuration_name" : "kms-encrypt-config-01",
"encrypt_mode" : "ENCRYPT",
"filling_method" : "PKCS7",
"mask_task_num" : 5,
"kms_context" : {
"kms_region" : "cn-north-4",
"kms_key_alias" : "kms-dsc-encrypt-key-01",
"kms_key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46"
},
"rotate_period" : 30,
"enable_rotate" : true
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 根据project_id查找用户的加密脱敏配置信息成功 |
错误码
请参见错误码。