Help Center/ Host Security Service/ API Reference/ API Description/ Vulnerability management/ Querying the Servers Affected by a Vulnerability
Updated on 2025-08-15 GMT+08:00

Querying the Servers Affected by a Vulnerability

Function

This API is used to query the servers affected by a vulnerability.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/vulnerability/hosts

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.

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.

host_name

No

String

Definition

Server name.

Constraints

N/A

Range

The value contains 1 to 256 characters.

Default Value

N/A

host_ip

No

String

Definition

Server IP address.

Constraints

N/A

Range

The value contains 1 to 256 characters.

Default Value

N/A

vul_id

Yes

String

Definition

Vulnerability ID.

Constraints

N/A

Range

The value can contain 0 to 64 characters.

Default Value

N/A

type

Yes

String

Definition

Vulnerability type to be queried.

Constraints

N/A

Range

  • linux_vul: Linux vulnerability

  • windows_vul: windows vulnerability

  • web_cms: Web-CMS vulnerability

  • app_vul: application vulnerability

  • urgent_vul: emergency vulnerability

Default Value

N/A

status

No

String

Definition

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

asset_value

No

String

Definition

Asset importance.

Constraints

N/A

Range

  • important

  • common

  • test

Default Value

N/A

group_name

No

String

Definition

Server group name.

Constraints

N/A

Range

The value can contain 0 to 256 characters.

Default Value

N/A

handle_status

No

String

Definition

Vulnerability handling status.

Constraints

N/A

Range

  • unhandled

  • handled

Default Value

N/A

severity_level

No

String

Definition

Severity.

Constraints

N/A

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.

You can use commas (,) to separate multiple values.

Default Value

N/A

is_affect_business

No

Boolean

Definition

Whether services are affected.

Constraints

N/A

Range

  • true: Services are affected.

  • false: Services are not affected.

Default Value

N/A

repair_priority

No

String

Definition

Fixing priority. Its value can be:

Constraints

N/A

Range

  • Critical

  • High

  • Medium

  • Low

You can use commas (,) to separate multiple values.

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

Integer

Definition

Number of affected cloud servers.

Range

The value range is 0 to 10,000.

data_list

Array of VulHostInfo objects

Definition

List of affected cloud servers.

Range

The value range is 1 to 10,000.

Table 5 VulHostInfo

Parameter

Type

Description

host_id

String

ID of the server affected by the vulnerability

severity_level

String

Definition

Severity.

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_name

String

Definition

Name of an affected server.

Range

The value can contain 1 to 256 characters.

host_ip

String

Definition

IP address of an affected server.

Range

The value can contain 1 to 256 characters.

agent_id

String

Definition

Agent ID of a server.

Range

The value can contain 1 to 128 characters.

version

String

Definition

Edition of a quota bound to a server.

Range

The value can contain 1 to 128 characters.

cve_num

Integer

Definition

Number of vulnerability CVEs.

Range

The value range is 0 to 10,000.

cve_id_list

Array of strings

Definition

CVE ID list of vulnerabilities.

Range

The value range is 1 to 10,000.

status

String

Definition

Vulnerability status.

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.

repair_cmd

String

Definition

Command line to be executed to fix the vulnerability. (This field is available only for Linux vulnerabilities.)

Range

The value can contain 1 to 256 characters.

app_path

String

Definition

Path of the application software. (This field is available only for application vulnerabilities.)

Range

The value can contain 1 to 512 characters.

region_name

String

Definition

Region.

Range

The value can contain 0 to 128 characters.

public_ip

String

Definition

Server EIP.

Range

The value can contain 0 to 128 characters.

private_ip

String

Definition

Server private IP address.

Range

The value can contain 0 to 128 characters.

group_id

String

Definition

Server group ID.

Range

The value can contain 0 to 128 characters.

group_name

String

Definition

Server group name.

Range

The value can contain 0 to 256 characters.

os_type

String

Definition

OS.

Range

The value can contain 0 to 32 characters.

asset_value

String

Definition

Asset importance.

Range

  • important: important asset

  • common: common asset

  • test: test asset

is_affect_business

Boolean

Definition

Whether services are affected.

Range

  • true: Services are affected.

  • false: Services are not affected.

first_scan_time

Long

Definition

First scan time.

Range

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

scan_time

Long

Definition

Scan time, in ms.

Range

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

support_restore

Boolean

Definition

Whether data can be rolled back to the backup created when the vulnerability is fixed.

Range

  • true: Rollback is allowed.

  • false: Rollback is not allowed.

disabled_operate_types

Array of disabled_operate_types objects

Definition

List of operation types that cannot be performed on the current server.

Range

The value range is 1 to 10,000.

repair_priority

String

Definition

Fixing priority. Its value can be:

Range

  • Critical

  • High

  • Medium

  • Low

Table 6 disabled_operate_types

Parameter

Type

Description

operate_type

String

Definition

Operation type.

Range

  • ignore: ignore

  • not_ignore: unignore

  • immediate_repair: fix

  • manual_repair: manual fix

  • verify

  • add_to_whitelist

reason

String

Definition

Reason why an operation cannot be performed.

Range

The value can contain 0 to 512 characters.

Example Requests

Query the first 10 records in the list of servers with EulerOS-SA-2021-1894 vulnerability.

GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/hosts?vul_id=EulerOS-SA-2021-1894&offset=0&limit=10

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "severity_level" : "Low",
    "host_name" : "ecs",
    "host_ip" : "xxx.xxx.xxx.xxx",
    "agent_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "version" : "hss.version.enterprise",
    "cve_num" : 1,
    "cve_id_list" : [ "CVE-2022-1664" ],
    "status" : "vul_status_ignored",
    "repair_cmd" : "zypper update update-alternatives",
    "app_path" : "/root/apache-tomcat-8.5.15/bin/bootstrap.jar",
    "support_restore" : true,
    "disabled_operate_types" : [ {
      "operate_type" : "immediate_repair",
      "reason" : "The kernel vulnerability of CCE container node cannot be automatically fixed."
    } ],
    "repair_priority" : "Critical"
  } ]
}

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

    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();
        ListVulHostsRequest request = new ListVulHostsRequest();
        try {
            ListVulHostsResponse response = client.listVulHosts(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 = ListVulHostsRequest()
        response = client.list_vul_hosts(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.ListVulHostsRequest{}
	response, err := client.ListVulHosts(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.