文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 漏洞管理-主机视图-主机列表-导出报告 - ShowVulReportData
更新时间:2025-10-31 GMT+08:00
分享

漏洞管理-主机视图-主机列表-导出报告 - ShowVulReportData

功能介绍

在主机视图中导出漏洞报告详细报告pdf格式

授权信息

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

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

URI

POST /v5/{project_id}/vulnerability/report/data

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目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位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

asset_value

String

参数解释:

资产重要性

约束限制:

不涉及

取值范围:

  • important:重要资产。

  • common:一般资产。

  • test:测试资产。

默认取值:

不涉及

group_name

String

参数解释

服务器组名称

约束限制

不涉及

取值范围

字符长度1-64位

默认取值

不涉及

host_ids

Array of strings

参数解释

服务器ID列表

约束限制

不涉及

取值范围

0-100个items

默认取值

不涉及

host_name

String

参数解释

主机名称

约束限制

不涉及

取值范围

字符长度1-64位

默认取值

不涉及

host_ip

String

参数解释

主机ip

约束限制

不涉及

取值范围

字符长度0-128位

默认取值

不涉及

severity_level

String

参数解释:

漏洞风险等级

约束限制:

不涉及

取值范围:

  • High:高。

  • Medium:中等。

  • Low:低。

  • Security:安全。

默认取值:

不涉及

handle_status

String

参数解释:

处置状态

约束限制:

不涉及

取值范围:

  • unhandled:未处理。

  • handled:已处理。

默认取值:

不涉及

status

String

参数解释:

主机的漏洞状态

约束限制:

不涉及

取值范围:

  • vul_status_unfix:未处理。

  • vul_status_ignored:已忽略。

  • vul_status_verified:验证中。

  • vul_status_fixing:修复中。

  • vul_status_fixed:已修复。

  • vul_status_reboot:修复待重启。

  • vul_status_failed:修复失败。

  • vul_status_fix_after_reboot:请重启主机再次修复。

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

sumary

sumary object

统计信息

hosts

Array of hosts objects

主机列表

vulnerabilities

Array of vulnerabilities objects

漏洞列表

report_create_time

Long

参数解释

报告生成时间

取值范围

最小值0,最大值9223372036854775807

vulnerability_total_count

Integer

参数解释

漏洞总数量

取值范围

最小值0,最大值10000000

host_total_count

Integer

参数解释

主机总数量

取值范围

最小值0,最大值20000

表6 sumary

参数

参数类型

描述

vul_num_repair_necessity

Integer

参数解释:

紧急修复漏洞数量

取值范围:

最小值0,最大值1000000

vul_num_unfixed

Integer

参数解释:

未完成修复的漏洞数量

取值范围:

最小值0,最大值1000000

vul_num_linux

Integer

参数解释:

linxu漏洞数量

取值范围:

最小值0,最大值1000000

vul_num_windows

Integer

参数解释:

windows的漏洞数量

取值范围:

最小值0,最大值1000000

vul_num_web_cms

Integer

参数解释:

web-cms的漏洞数量

取值范围:

最小值0,最大值1000000

vul_num_app

Integer

参数解释:

应用漏洞

取值范围:

最小值0,最大值1000000

host_num_risk

Integer

参数解释:

有风险的主机数量

取值范围:

最小值0,最大值1000000

host_num_high_risk

Integer

参数解释:

有高危风险的主机数量

取值范围:

最小值0,最大值1000000

host_num_medium_risk

Integer

参数解释:

有中危风险的主机数量

取值范围:

最小值0,最大值1000000

host_num_low_risk

Integer

参数解释:

有低危风险的主机数量

取值范围:

最小值0,最大值1000000

affect_asset_num_important

Integer

参数解释:

受影响的重要资产数量

取值范围:

最小值0,最大值1000000

affect_asset_num_common

Integer

参数解释:

受影响的一般资产数量

取值范围:

最小值0,最大值1000000

affect_asset_num_test

Integer

参数解释:

受影响的测试资产数量

取值范围:

最小值0,最大值1000000

表7 hosts

参数

参数类型

描述

host_name

String

参数解释

主机名称

取值范围

字符长度1-256位

public_ip

String

参数解释

服务器公网ip

取值范围

字符长度1-64位

private_ip

String

参数解释

服务器私网ip

取值范围

字符长度0-128位

scan_time

Long

参数解释

最近扫描时间

取值范围

最小值0,最大值9223372036854775807

severity_level

String

参数解释

漏洞风险等级

取值范围

  • Critical:紧急。

  • High:高危。

  • Medium:中危。

  • Low:低危。

vul_total_num

Integer

参数解释

漏洞数

取值范围

最小值0,最大值10000000

host_id

String

参数解释

主机ID

取值范围

字符长度1-128位

表8 vulnerabilities

参数

参数类型

描述

vul_name

String

参数解释

漏洞名称

取值范围

字符长度0-256位

scan_time

Long

参数解释

最近扫描时间

取值范围

最小值0,最大值9223372036854775807

type

String

参数解释

漏洞类型

取值范围

  • linux_vul:linux漏洞。

  • windows_vul:windows漏洞。

  • web_cms:Web-CMS漏洞。

  • app_vul:应用漏洞。

cve_list

Array of cve_list objects

CVE列表

repair_priority

String

参数解释

修复优先级

取值范围

  • Critical:紧急。

  • High:高。

  • Medium:中。

  • Low:低。

host_num

Integer

参数解释

影响主机数量

取值范围

最小值0,最大值20000

host_id_list

Array of strings

参数解释:

主机ID列表(数组长度跟host_num对不上时,主机数量以host_num为准)

取值范围:

最小值0,最大值20000

表9 cve_list

参数

参数类型

描述

cve_id

String

参数解释

CVE ID

取值范围

字符长度1-32位

cvss

Float

参数解释

CVSS分值

取值范围

最小值0,最大值10

请求示例

导出project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的未处置漏洞的报告

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/report/data?enterprise_project_id=all_granted_eps

{
  "handle_status" : "unhandled",
  "host_ids" : [ ]
}

响应示例

状态码:200

请求已成功

{
  "sumary" : [ {
    "vul_num_repair_necessity" : 0,
    "vul_num_unfixed" : 1,
    "vul_num_linux" : 1,
    "vul_num_windows" : 0,
    "vul_num_web_cms" : 0,
    "vul_num_app" : 1,
    "vul_num_urgent" : 0,
    "host_num_risk" : 1,
    "host_num_high_risk" : 1,
    "host_num_medium_risk" : 1,
    "host_num_low_risk" : 1,
    "affect_asset_num_important" : 1,
    "affect_asset_num_common" : 0,
    "affect_asset_num_test" : 0
  } ],
  "hosts" : [ {
    "host_id" : "cf2f2f7d-48be-45a0-ad6f-5a89e62c4677",
    "agent_id" : "aba3b0eedecb5335aaa2804334783e556cf3811fb81b164abbf2dfe754563468",
    "host_name" : "00693117",
    "group_id" : "6f41a5fd-d435-4102-9a8b-73a9abc49418",
    "group_name" : "xxxxxxxxxx",
    "asset_value" : "important",
    "private_ip" : "192.168.0.246",
    "public_ip" : "",
    "severity_level" : "High",
    "vul_total_num" : 1
  } ],
  "vulnerabilities" : [ {
    "type" : "linux_vul",
    "vul_name" : "HCE2-SA-2025-0089 An update for expat is now available for HCE 2.0",
    "vul_id\"" : "HCE2-SA-2025-0089",
    "repair_priority\"" : "High",
    "host_num" : 1,
    "scan_time" : 1755139626431,
    "host_id_list" : [ "cf2f2f7d-48be-45a0-ad6f-5a89e62c4677" ],
    "cve_list\"" : [ {
      "cve_id" : "CVE-2024-50602"
    } ],
    "repair_priority_list\"" : [ {
      "repair_priority" : "Critical",
      "host_num" : 0
    }, {
      "repair_priority" : "High",
      "host_num" : 1
    }, {
      "repair_priority" : "Medium",
      "host_num" : 0
    }, {
      "repair_priority" : "Low",
      "host_num" : 0
    } ]
  } ],
  "report_create_time" : 1755570076030,
  "vulnerability_total_count" : 1
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档