查询漏洞列表 - ListVulnerabilities
功能介绍
查询漏洞列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/vulnerability/vulnerabilities
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
type |
否 |
String |
参数解释: 漏洞类型 约束限制: 不涉及 取值范围:
默认取值: linux_vul,默认查询linux漏洞 |
|
vul_id |
否 |
String |
参数解释: 漏洞ID 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
|
vul_name |
否 |
String |
参数解释: 漏洞名称 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
repair_priority |
否 |
String |
参数解释: 漏洞修复优先级 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
handle_status |
否 |
String |
参数解释: 漏洞的处置状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
cve_id |
否 |
String |
参数解释: 漏洞cve编号 约束限制: 不涉及 取值范围: 字符长度0-32位 默认取值: 不涉及 |
|
label_list |
否 |
String |
参数解释: 漏洞标签 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
status |
否 |
String |
参数解释: 漏洞状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
asset_value |
否 |
String |
参数解释: 存在漏洞主机的资产重要性 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
group_name |
否 |
String |
参数解释: 存在漏洞主机的所属服务器组 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Long |
参数解释: 漏洞总数 取值范围: 取值0-2147483647 |
|
data_list |
Array of VulInfo objects |
参数解释: 漏洞数据列表 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vul_name |
String |
参数解释: 漏洞名称 取值范围: 字符长度0-256位 |
|
vul_id |
String |
参数解释: 漏洞ID 取值范围: 字符长度0-64位 |
|
label_list |
Array of strings |
参数解释: 漏洞标签列表 取值范围: 不涉及 |
|
repair_necessity |
String |
参数解释: 漏洞修复的必要性 取值范围:
|
|
severity_level |
String |
参数解释: 漏洞风险级别 取值范围:
|
|
host_num |
Integer |
参数解释: 受影响服务器台数 取值范围: 取值0-2147483647 |
|
unhandle_host_num |
Integer |
参数解释: 未处理主机台数:除已忽略和已修复的主机数量 取值范围: 取值0-2147483647 |
|
scan_time |
Long |
参数解释: 最近扫描时间,时间戳单位:毫秒 取值范围: 取值0-9223372036854775807 |
|
solution_detail |
String |
参数解释: 修复漏洞的指导意见 取值范围: 字符长度0-65534位 |
|
url |
String |
参数解释: URL链接 取值范围: 字符长度0-2083位 |
|
description |
String |
参数解释: 漏洞描述 取值范围: 字符长度0-65534位 |
|
type |
String |
参数解释: 漏洞类型 取值范围:
|
|
host_id_list |
Array of strings |
参数解释: 可处置该漏洞的主机ID列表 取值范围: 不涉及 |
|
cve_list |
Array of cve_list objects |
参数解释: 漏洞关联的cve信息列表 取值范围: 不涉及 |
|
patch_url |
String |
参数解释: 补丁地址 取值范围: 字符长度0-512位 |
|
repair_priority |
String |
参数解释: 修复优先级 取值范围:
|
|
hosts_num |
VulnerabilityHostNumberInfo object |
影响主机数量 |
|
repair_success_num |
Integer |
参数解释: 修复成功次数 取值范围: 取值0-1000000 |
|
fixed_num |
Long |
参数解释: 修复数量 取值范围: 取值0-1000000 |
|
ignored_num |
Long |
参数解释: 忽略数量 取值范围: 取值0-1000000 |
|
verify_num |
Integer |
参数解释: 验证数量 取值范围: 取值0-1000000 |
|
repair_priority_list |
Array of RepairPriorityListInfo objects |
参数解释: 修复优先级,每个修复优先级对应的主机数量 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cve_id |
String |
参数解释: CVE ID 取值范围: 字符长度0-32位 |
|
cvss |
Float |
参数解释: CVSS分值 取值范围: 取值0-10 |
请求示例
查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的漏洞列表前10条数据。
GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/vulnerabilities?offset=0&limit=10
响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"description" : "It was discovered that FreeType did not correctly handle certain malformed font files. If a user were tricked into using a specially crafted font file, a remote attacker could cause FreeType to crash, or possibly execute arbitrary code.",
"host_id_list" : [ "caa958ad-a481-4d46-b51e-6861b8864515" ],
"host_num" : 1,
"scan_time" : 1661752185836,
"severity_level" : "Critical",
"repair_necessity" : "Critical",
"solution_detail" : "To upgrade the affected software",
"type" : "linux_vul",
"unhandle_host_num" : 0,
"url" : "https://ubuntu.com/security/CVE-2022-27405",
"vul_id" : "USN-5528-1",
"vul_name" : "USN-5528-1: FreeType vulnerabilities",
"repair_priority_list" : [ {
"repair_priority" : "Critical",
"host_num" : 0
}, {
"repair_priority" : "High",
"host_num" : 0
}, {
"repair_priority" : "Medium",
"host_num" : 1
}, {
"repair_priority" : "Low",
"host_num" : 0
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。