查询漏洞白名单列表 - ListVulWhiteList
功能介绍
查询漏洞白名单列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/vulnerability/white-lists
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
是 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 不涉及 |
|
vul_name |
否 |
String |
参数解释: 漏洞名称 约束限制: 不涉及 取值范围: 字符长度0-256 默认取值: 不涉及 |
|
vul_type |
否 |
String |
参数解释: 漏洞类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0，最大值2147483647 |
|
data_list |
Array of VulWhiteListDetailResponseInfo objects |
参数解释: 漏洞白名单列表 取值范围: 最小值0，最大值2147483647 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 白名单id 取值范围: 字符长度0-256 |
|
vul_id |
String |
参数解释: 漏洞id 取值范围: 字符长度0-256 |
|
vul_name |
String |
参数解释: 漏洞名称 取值范围: 字符长度0-256 |
|
vul_type |
String |
参数解释: 漏洞类型 取值范围:
|
|
cves |
Array of cves objects |
参数解释: 漏洞对应的cve列表 取值范围: 最小值0，最大值2147483647 |
|
rule_type |
String |
参数解释: 白名单规则类型 取值范围:
|
|
hosts |
Array of hosts objects |
参数解释: 白名单规则为“指定主机”时，指定的主机列表 取值范围: 最小值0，最大值2147483647 |
|
description |
String |
参数解释: 白名单的描述信息 取值范围: 字符长度0-1000 |
请求示例
查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的漏洞白名单列表。
GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/white-lists?offset=0&limit=200&enterprise_project_id=all_granted_eps
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"id" : "576a1dac-d3ba-4aa6-8725-3eb2ca83172e",
"cves" : [ {
"cvss" : 9.8,
"cve_id" : "CVE-2020-27068"
}, {
"cvss" : 5.5,
"cve_id" : "CVE-2020-36322"
}, {
"cvss" : 7.1,
"cve_id" : "CVE-2020-36386"
} ],
"vul_id" : "EulerOS-SA-2022-1171",
"vul_name" : "EulerOS-SA-2022-1171 Important: kernel security update",
"vul_type" : "linux_vul",
"rule_type" : "specific_host",
"description" : ""
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
