Vulnerability Management - Server View - Server List - Export Report

Function

This API is used to export the detailed vulnerability report in PDF format in the server view.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
asset_value	No	String	Definition Asset importance. Constraints N/A Range important: important asset common: common asset test: test asset Default Value N/A
group_name	No	String	Definition Server group name. Constraints N/A Range Length: 1 to 64 characters Default Value N/A
host_ids	No	Array of strings	Definition Server ID list Constraints N/A Range 0-100 items Default Value N/A
host_name	No	String	Definition Server name Constraints N/A Range Length: 1 to 64 characters Default Value N/A
host_ip	No	String	Definition Server IP address. Constraints N/A Range Length: 0 to 128 characters Default Value N/A
severity_level	No	String	Definition Risk level. Constraints N/A Range High: high Medium: medium Low: low Security: security Default Value N/A
handle_status	Yes	String	Definition Handling status. Constraints N/A Range unhandled: unhandled. handled: handled. Default Value N/A
status	No	String	Definition Server vulnerability status. Constraints N/A Range vul_status_unfix: not handled vul_status_ignored: ignored vul_status_verified: verification in progress vul_status_fixing: fixing vul_status_fixed: fixed vul_status_reboot: fixed and pending restart vul_status_failed: fix failed vul_status_fix_after_reboot: Restart the server and try again. Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
sumary	sumary object	Statistics. (This field has been deprecated.)
summary	summary object	Statistics information.
hosts	Array of hosts objects	Hosts.
vulnerabilities	Array of vulnerabilities objects	Vulnerability list
report_create_time	Long	Definition Report generation time. Range Minimum value: 0; maximum value: 9223372036854775807
vulnerability_total_count	Integer	Definition Total number of vulnerabilities. Range Minimum value: 0; maximum value: 10000000
host_total_count	Integer	Definition Total number of servers. Range Minimum value: 0; maximum value: 20000

**Table 6** sumary
Parameter	Type	Description
vul_num_repair_necessity	Integer	Definition Number of urgently fixed vulnerabilities Range Minimum value: 0; maximum value: 1000000

**Table 7** summary
Parameter	Type	Description
vul_num_repair_necessity	Integer	Definition Number of fixed emergency vulnerabilities. Range The minimum value is 0 and the maximum value is 1,000,000.
vul_num_unfixed	Integer	Definition Number of vulnerabilities that have not been fixed. Range The minimum value is 0 and the maximum value is 1,000,000.
vul_num_linux	Integer	Definition Number of Linux vulnerabilities. Range The minimum value is 0 and the maximum value is 1,000,000.
vul_num_windows	Integer	Definition Number of Windows vulnerabilities. Range The minimum value is 0 and the maximum value is 1,000,000.
vul_num_web_cms	Integer	Definition Number of web-cms vulnerabilities. Range The minimum value is 0 and the maximum value is 1,000,000.
vul_num_app	Integer	Definition Application vulnerability Range The minimum value is 0 and the maximum value is 1,000,000.
host_num_risk	Integer	Definition Number of unsafe servers Range The minimum value is 0 and the maximum value is 1,000,000.
host_num_high_risk	Integer	Definition Number of servers with high risks. Range The minimum value is 0 and the maximum value is 1,000,000.
host_num_medium_risk	Integer	Definition Number of servers with medium risks. Range The minimum value is 0 and the maximum value is 1,000,000.
host_num_low_risk	Integer	Definition Number of servers with low risks Range The minimum value is 0 and the maximum value is 1,000,000.
affect_asset_num_important	Integer	Definition Number of affected critical assets Range The minimum value is 0 and the maximum value is 1,000,000.
affect_asset_num_common	Integer	Definition Number of affected general assets Range The minimum value is 0 and the maximum value is 1,000,000.
affect_asset_num_test	Integer	Definition Number of affected test assets Range The minimum value is 0 and the maximum value is 1,000,000.

**Table 8** hosts
Parameter	Type	Description
host_name	String	Definition Server name Range Length: 1 to 256 characters
public_ip	String	Definition Server EIP. Range Length: 1 to 64 characters
private_ip	String	Definition Server private IP address. Range Length: 0 to 128 characters
scan_time	Long	Definition Last scan time. Range Minimum value: 0; maximum value: 9223372036854775807
severity_level	String	Definition Risk level. Range Critical: critical High: high-risk Medium: medium-risk Low: low-risk
vul_total_num	Integer	Definition Number of vulnerabilities Range Minimum value: 0; maximum value: 10000000
host_id	String	Definition Host ID. Range Length: 1 to 128 characters

**Table 9** vulnerabilities
Parameter	Type	Description
vul_name	String	Definition Vulnerability name. Range Length: 0 to 256 characters
scan_time	Long	Definition Last scan time. Range Minimum value: 0; maximum value: 9223372036854775807
type	String	Definition Vulnerability type. Range linux_vul: Linux vulnerability. windows_vul: Windows vulnerability. web_cms: Web-CMS vulnerability. app_vul: application vulnerability.
cve_list	Array of cve_list objects	CVE list
repair_priority	String	Definition Fixing priority. Range Critical: critical High: high Medium: medium Low: low
host_num	Integer	Definition Number of affected servers. Range Minimum value: 0; maximum value: 20000
host_id_list	Array of strings	Definition Server ID list (If the array length is different from that of host_num, the number of servers is subject to host_num.) Range Minimum value: 0; maximum value: 20000

**Table 10** cve_list
Parameter	Type	Description
cve_id	String	Definition CVE ID Range Length: 1 to 32 characters
cvss	Float	Definition CVSS score. Range Minimum value: 0; maximum value: 10

Example Requests

Export the report of unhandled vulnerabilities whose project_id is 2b31ed520xxxxxxebedb6e57xxxxxxxx.

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

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

Example Responses

Status code: 200

Request succeeded.

{
  "summary" : {
    "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,
    "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",
    "host_name" : "00693117",
    "private_ip" : "192.168.0.246",
    "public_ip" : "",
    "severity_level" : "High",
    "vul_total_num" : 1,
    "scan_time" : 253
  } ],
  "vulnerabilities" : [ {
    "type" : "linux_vul",
    "vul_name" : "HCE2-SA-2025-0089 An update for expat is now available for HCE 2.0",
    "repair_priority" : "High",
    "host_num" : 1,
    "scan_time" : 1755139626431,
    "host_id_list" : [ "cf2f2f7d-48be-45a0-ad6f-5a89e62c4677" ],
    "cve_list" : [ {
      "cve_id" : "CVE-2024-50602",
      "cvss" : 5
    } ]
  } ],
  "report_create_time" : 1755570076030,
  "vulnerability_total_count" : 1,
  "host_total_count" : 23
}