获取分级列表 - ListScanSecurityLevels
功能介绍
功能介绍:查询数据安全分级列表,支持分页和条件过滤。 关键参数说明:支持offset/limit分页、name名称过滤、category类别过滤(BUILT_IN/BUILT_IN_COPY/BUILT_SELF)、is_deleted是否含已删除。 返回值说明:返回分级总数及分级列表(含级别ID、名称、颜色、使用数量等)。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/scan-security-levels
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 分页偏移 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 不涉及 取值范围: 1-1000 默认取值: 100 |
| name | 否 | String | 参数解释: 安全级别名称,用于按名称过滤安全级别 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| category | 否 | String | 参数解释: 类别 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| is_deleted | 否 | Boolean | 参数解释: 是否包含已删除的分级,用于指定查询结果是否包含已删除的安全等级 约束限制: 不涉及 取值范围: true-包含,false-不包含 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Long | 参数解释: 总记录数 取值范围: 不涉及 |
| security_levels_list | Array of SecurityLevel objects | 参数解释: 安全级别列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| level_id | String | 参数解释: 级别ID 取值范围: 不涉及 |
| project_id | String | 参数解释: 项目ID 取值范围: 不涉及 |
| security_level_name | String | 参数解释: 安全级别名称,标识安全等级的名称 取值范围: 字符串类型 |
| color_number | Integer | 参数解释: 颜色编号,标识安全等级在控制台中对应的显示颜色 取值范围: 整数值 |
| security_level_desc | String | 参数解释: 安全级别描述 取值范围: 不涉及 |
| used_count | Integer | 参数解释: 使用数量,标识该安全等级被引用的数量 取值范围: 整数 |
| category | String | 参数解释: 类别 取值范围: 不涉及 |
| create_time | Long | 参数解释: 创建时间,格式为13位毫秒级时间戳,表示安全等级的创建时间 取值范围: 13位毫秒级时间戳 |
| update_time | Long | 参数解释: 更新时间,格式为13位毫秒级时间戳,表示安全等级的更新时间 取值范围: 13位毫秒级时间戳 |
| sort_weight | Integer | 参数解释: 排序权重 取值范围: 不涉及 |
| is_deleted | Boolean | 参数解释: 是否已删除 取值范围: true-是,false-否 |
请求示例
获取分级列表
/v1/2b31ed520aabbccddeedb6e571234567/scan-security-levels
响应示例
状态码:200
{
"total" : 1,
"security_levels_list" : [ {
"level_id" : "3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d",
"project_id" : "2d52d09a-f0d3-4c1a-86b4-fc7e435e9c7a",
"security_level_name" : "security-level-01",
"color_number" : 10,
"security_level_desc" : "security-level-01",
"used_count" : 100,
"category" : "BUILT_IN",
"create_time" : 1700000000000,
"update_time" : 1700000000000,
"sort_weight" : 100,
"is_deleted" : true
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。