查询自定义凭据列表 - ShowCustomCredentialsList
功能介绍
功能介绍:查询自定义凭据列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/credential-leakage/custom-credentials
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页查询每页条数 约束限制: 必须为整数,取值范围 1~1000 取值范围: 1-1000 默认取值: 100 |
| offset | 否 | Integer | 参数解释: 分页查询偏移量(服务端按 offset/limit 计算页码) 约束限制: 必须为整数且不小于 0 取值范围: 0-2147483647 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | Array of CustomCredential objects | 参数解释: 自定义凭据列表 取值范围: 不涉及 |
| total | Long | 参数解释: 总记录数 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 凭据ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: 凭据名称 取值范围: 不涉及 |
| user_name | String | 参数解释: 用户名 取值范围: 不涉及 |
| user_id | String | 参数解释: 用户ID,唯一标识 取值范围: 不涉及 |
| value | String | 参数解释: 脱敏后的自定义凭据值(保留首尾各2位,中间用*替代;长度不超过4时仅保留前2位) 取值范围: 不涉及 |
| type | String | 参数解释: 凭据类型 取值范围: |
| description | String | 参数解释: 资源描述信息 取值范围: 不涉及 |
| rule_type | String | 参数解释: 自定义凭据匹配规则类型(当前创建接口固定为 KEYWORD) 取值范围: |
| create_time | Long | 参数解释: 创建时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
| update_time | Long | 参数解释: 更新时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
请求示例
查询自定义凭据列表请求示例
/v1/2b31ed5200000ebedb6e570000000000/credential-leakage/custom-credentials?limit=100&offset=0
响应示例
状态码:200
{
"result" : [ {
"id" : 1001,
"name" : "custom-credential-01",
"user_name" : "security-admin",
"user_id" : "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
"value" : "******",
"type" : "CUSTOM",
"description" : "用于检测自定义敏感凭据泄露的规则",
"rule_type" : "KEYWORD",
"create_time" : 1700000000000,
"update_time" : 1700086400000
} ],
"total" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。