Help Center/ Host Security Service/ API Reference/ API Description/ Vulnerability Report/ Vulnerability Management - Server View - Server List - Export Report
Updated on 2025-09-08 GMT+08:00

Vulnerability Management - Server View - Server List - Export Report

Function

Export the detailed vulnerability report in PDF format in the server view.

Calling Method

For details, see Calling APIs.

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

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

vul_num_unfixed

Integer

Definition

Number of vulnerabilities not fixed

Range

Minimum value: 0; maximum value: 1000000

vul_num_linux

Integer

Definition

Number of Linxu vulnerabilities

Range

Minimum value: 0; maximum value: 1000000

vul_num_windows

Integer

Definition

Number of Windows vulnerabilities

Range

Minimum value: 0; maximum value: 1000000

vul_num_web_cms

Integer

Definition

Number of web-cms vulnerabilities

Range

Minimum value: 0; maximum value: 1000000

vul_num_app

Integer

Definition

Application vulnerability

Range

Minimum value: 0; maximum value: 1000000

host_num_risk

Integer

Definition

Number of unsafe servers

Range

Minimum value: 0; maximum value: 1000000

host_num_high_risk

Integer

Definition

Number of servers with high risks

Range

Minimum value: 0; maximum value: 1000000

host_num_medium_risk

Integer

Definition

Number of servers with medium risks

Range

Minimum value: 0; maximum value: 1000000

host_num_low_risk

Integer

Definition

Number of servers with low risks

Range

Minimum value: 0; maximum value: 1000000

affect_asset_num_important

Integer

Definition

Number of affected critical assets

Range

Minimum value: 0; maximum value: 1000000

affect_asset_num_common

Integer

Definition

Number of affected general assets

Range

Minimum value: 0; maximum value: 1000000

affect_asset_num_test

Integer

Definition

Number of affected test assets

Range

Minimum value: 0; maximum value: 1000000

Table 7 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 8 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 9 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

""

Example Responses

Status code: 200

Request succeeded.

{
  "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
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ShowVulReportDataSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowVulReportDataRequest request = new ShowVulReportDataRequest();
        VulReportRequestBody body = new VulReportRequestBody();
        request.withBody(body);
        try {
            ShowVulReportDataResponse response = client.showVulReportData(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowVulReportDataRequest()
        request.body = VulReportRequestBody(
        )
        response = client.show_vul_report_data(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowVulReportDataRequest{}
	request.Body = &model.VulReportRequestBody{
	}
	response, err := client.ShowVulReportData(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.