Updated on 2025-08-15 GMT+08:00

Querying the Vulnerability List

Function

This API is used to query the list of detected vulnerabilities.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/vulnerability/vulnerabilities

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.

type

No

String

Definition

Vulnerability type.

Constraints

N/A

Range

  • linux_vul: Linux vulnerabilities

  • windows_vul: Windows vulnerabilities

  • web_cms: Web-CMS vulnerabilities

  • app_vul: application vulnerabilities

Default Value

linux_vul (Linux vulnerabilities are queried by default.)

vul_id

No

String

Definition

Vulnerability ID.

Constraints

N/A

Range

The value can contain 0 to 256 characters.

Default Value

N/A

vul_name

No

String

Definition

Vulnerability name.

Constraints

N/A

Range

The value can contain 0 to 256 characters.

Default Value

N/A

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A

Options:

Value range: 10-200

Default value:

10

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

The default value is 0.

repair_priority

No

String

Definition

Vulnerability fixing priority.

Constraints

N/A

Range

  • Critical

  • High

  • Medium

  • Low

Default Value

N/A

handle_status

No

String

Definition

Vulnerability handling status.

Constraints

N/A

Range

  • unhandled

  • handled

Default Value

N/A

cve_id

No

String

Definition

CVE ID.

Constraints

N/A

Range

The value can contain 0 to 32 characters.

Default Value

N/A

label_list

No

String

Definition

Vulnerability tag.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

status

No

String

Definition

Vulnerability status.

Constraints

N/A

Range

  • vul_status_unfix: not fixed

  • 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

asset_value

No

String

Definition

Asset importance of a server with vulnerabilities.

Constraints

N/A

Range

  • important

  • common

  • test

Default Value

N/A

group_name

No

String

Definition

The group that a server with vulnerabilities belongs to.

Constraints

N/A

Range

The value can contain 0 to 256 characters.

Default Value

N/A

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Long

Definition

Total number of vulnerabilities.

Range

The value range is 0 to 2,147,483,647.

data_list

Array of VulInfo objects

Definition

Vulnerability data list.

Range

N/A

Table 5 VulInfo

Parameter

Type

Description

vul_name

String

Definition

Vulnerability name.

Range

The value can contain 0 to 256 characters.

vul_id

String

Definition

Vulnerability ID.

Range

The value can contain 0 to 64 characters.

label_list

Array of strings

Definition

Vulnerability tag list.

Range

N/A

repair_necessity

String

Definition

Necessity of fixing a vulnerability.

Range

  • Critical: The CVSS score of the vulnerability is greater than or equal to 9, corresponding to the high risk level on the console.

    • High: The CVSS score of the vulnerability is greater than or equal to 7 and less than 9, corresponding to the medium risk level on the console.

  • Medium: The CVSS score of the vulnerability is greater than or equal to 4 and less than 7, corresponding to the medium risk level on the console.

    • Low: The CVSS score of the vulnerability is less than 4, corresponding to the low risk level on the console.

severity_level

String

Definition

Vulnerability risk level.

Range

  • Critical: The CVSS score of the vulnerability is greater than or equal to 9, corresponding to the high risk level on the console.

  • High: The CVSS score of the vulnerability is greater than or equal to 7 and less than 9, corresponding to the medium risk level on the console.

  • Medium: The CVSS score of the vulnerability is greater than or equal to 4 and less than 7, corresponding to the medium risk level on the console.

  • Low: The CVSS score of the vulnerability is less than 4, corresponding to the low risk level on the console.

host_num

Integer

Definition

Number of affected servers.

Range

The value range is 0 to 2,147,483,647.

unhandle_host_num

Integer

Definition

Number of unhandled servers, excluding ignored and fixed servers.

Range

The value range is 0 to 2,147,483,647.

scan_time

Long

Definition

Latest scan time, in ms.

Range

The value range is 0 to 9,223,372,036,854,775,807.

solution_detail

String

Definition

Vulnerability fixing guide.

Range

The value can contain 0 to 65,534 characters.

url

String

Definition

URL link.

Range

The value can contain 0 to 2,083 characters.

description

String

Definition

Vulnerability description.

Range

The value can contain 0 to 65,534 characters.

type

String

Definition

Vulnerability type.

Range

  • linux_vul: Linux vulnerabilities

  • windows_vul: Windows vulnerabilities

  • web_cms: Web-CMS vulnerabilities

  • app_vul: application vulnerabilities

host_id_list

Array of strings

Definition

ID list of servers where the vulnerability can be handled.

Range

N/A

cve_list

Array of cve_list objects

Definition

List of CVE information associated with the vulnerability.

Range

N/A

patch_url

String

Definition

Patch address.

Range

The value can contain 0 to 512 characters.

repair_priority

String

Definition

Fixing priority.

Range

  • Critical

  • High

  • Medium

  • Low

hosts_num

VulnerabilityHostNumberInfo object

Number of affected servers

repair_success_num

Integer

Definition

Number of successful fixes.

Range

The value range is 0 to 1,000,000.

fixed_num

Long

Definition

Number of fixes.

Range

The value ranges from 0 to 1,000,000.

ignored_num

Long

Definition

Number of ignored items.

Range

The value ranges from 0 to 1,000,000.

verify_num

Integer

Definition

Number of verifications.

Range

The value range is 0 to 1,000,000.

repair_priority_list

Array of RepairPriorityListInfo objects

Definition

Fixing priorities. The number of servers corresponding to each priority is displayed.

Range

N/A

Table 6 cve_list

Parameter

Type

Description

cve_id

String

Definition

CVE ID

Range

The value can contain 0 to 32 characters.

cvss

Float

Definition

CVSS score.

Range

Value range: 0 to 10

Table 7 VulnerabilityHostNumberInfo

Parameter

Type

Description

important

Integer

Definition

Number of important servers.

Range

The value range is 0 to 10,000.

common

Integer

Definition

Number of common servers.

Range

The value range is 0 to 10,000.

test

Integer

Definition

Number of test servers.

Range

The value range is 0 to 10,000.

Table 8 RepairPriorityListInfo

Parameter

Type

Description

repair_priority

String

Definition

Fixing priority.

Range

  • Critical

  • High

  • Medium

  • Low

host_num

Integer

Definition

Number of servers corresponding to the current fixing priority.

Range

The value range is 0 to 2,147,483,647.

Example Requests

Query the first 10 records in the vulnerability list whose project_id is 2b31ed520xxxxxxebedb6e57xxxxxxxx.

GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/vulnerabilities?offset=0&limit=10

Example Responses

Status code: 200

Request succeeded.

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

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
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 ListVulnerabilitiesSolution {

    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();
        ListVulnerabilitiesRequest request = new ListVulnerabilitiesRequest();
        try {
            ListVulnerabilitiesResponse response = client.listVulnerabilities(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
# 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 = ListVulnerabilitiesRequest()
        response = client.list_vulnerabilities(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
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.ListVulnerabilitiesRequest{}
	response, err := client.ListVulnerabilities(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.