文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 查询漏洞白名单详情 - ShowVulWhiteListDetail
更新时间:2025-10-31 GMT+08:00
分享

查询漏洞白名单详情 - ShowVulWhiteListDetail

功能介绍

查询漏洞白名单详情

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/vulnerability/white-list/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

id

String

参数解释:

漏洞白名单ID

约束限制:

不涉及

取值范围:

字符长度1-256

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

白名单id

取值范围:

字符长度0-256

vul_id

String

参数解释:

漏洞id

取值范围:

字符长度0-256

vul_name

String

参数解释:

漏洞名称

取值范围:

字符长度0-256

vul_type

String

参数解释:

漏洞类型

取值范围:

  • linux_vul:linux漏洞

  • windows_vul:windows漏洞

  • web_cms:Web-CMS漏洞

  • app_vul:应用漏洞

cves

Array of cves objects

参数解释:

漏洞对应的cve列表

取值范围:

最小值0,最大值2147483647

rule_type

String

参数解释:

白名单规则类型

取值范围:

  • all_host:白名单应用于全部主机

  • specific_host:白名单应用于指定主机

hosts

Array of hosts objects

参数解释:

白名单规则为“指定主机”时,指定的主机列表

取值范围:

最小值0,最大值2147483647

description

String

参数解释:

白名单的描述信息

取值范围:

字符长度0-1000

表5 cves

参数

参数类型

描述

cve_id

String

参数解释:

cve id

取值范围:

字符长度0-256

cvss

Float

参数解释:

cve的cvss评分

取值范围:

最小值0,最大值10

表6 hosts

参数

参数类型

描述

host_id

String

参数解释:

主机id

取值范围:

字符长度0-128

host_name

String

参数解释:

主机名称

取值范围:

字符长度0-128

请求示例

查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx,漏洞白名单id为57d20b3f-154c-4f21-abf0-473b7426aead的详细信息。

GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/white-list/57d20b3f-154c-4f21-abf0-473b7426aead?enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

{
  "id" : "57d20b3f-154c-4f21-abf0-473b7426aead",
  "hosts" : [ {
    "host_id" : "a987f9f5-85a1-4c79-b023-41188b5e1cb3",
    "host_name" : "30074191-hss-勿动"
  } ],
  "cves" : [ {
    "cvss" : 4.4,
    "cve_id" : "CVE-2024-25629"
  } ],
  "vul_id" : "EulerOS-SA-2024-2900",
  "vul_name" : "EulerOS-SA-2024-2900 c-ares security update",
  "vul_type" : "linux_vul",
  "rule_type" : "specific_host"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档