Help Center/ Host Security Service/ API Reference/ API Description/ Vulnerability Management/ Querying Details About Affected Servers - Software List
Updated on 2025-09-08 GMT+08:00

Querying Details About Affected Servers - Software List

Function

This API is used to query details about the software list of affected servers.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/vulnerability/{host_id}/apps

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

host_id

Yes

String

Definition

Server ID.

Constraints

N/A

Range

Length: 1 to 128 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.

vul_id

No

String

Definition

Vulnerability ID.

Constraints

N/A

Range

Length: 0 to 256 characters

Default Value

N/A

handle_status

No

String

Definition

Vulnerability handling status.

Constraints

N/A

Range

  • handled

  • unhandled

Default Value

N/A

container_id

No

String

Definition

ID of the container where the vulnerability exists.

Constraints

N/A

Range

Length: 0 to 128 characters

Default Value

N/A

is_container

No

Boolean

Definition

Whether the container scenario is involved.

Constraints

N/A

Range

  • true: container scenario

  • false: non-container scenario

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

data_list

Array of data_list objects

Definition

Software information list

Range

N/A

total_num

Integer

Definition

Total number.

Range

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

Table 5 data_list

Parameter

Type

Description

app_name

String

Definition

App name

Range

Length: 1 to 128 characters

path

String

Definition

Path of the software that has vulnerabilities. This field is available only when you query vulnerabilities that have software paths, such as application vulnerabilities and emergency vulnerabilities. (Note: This field is about to be discarded. Use the paths field to obtain software path information.)

Range

Length: 1 to 512 characters

paths

Array of paths objects

Definition

List of software paths that have vulnerabilities. This field is available only when you query vulnerabilities that have software paths, such as application vulnerabilities and emergency vulnerabilities.

Range

N/A

rule

String

Definition

Vulnerability matching rule hit by software.

Range

Length: 1 to 512 characters

Table 6 paths

Parameter

Type

Description

app_path

String

Definition

Path of the software that has vulnerabilities.

Range

Length: 1 to 512 characters

app_version

String

Definition

Software version

Range

Length: 1 to 64 characters

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.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "mysql",
    "path" : "/usr/sbin",
    "paths" : [ {
      "app_path" : "/usr/sbin",
      "app_version" : "5.7.22",
      "status" : "vul_status_unfix"
    } ],
    "rule" : "Your mysql version has this vulnerability. Current version: 5.7.22 Versions with this vulnerability: (5.7.0,5.7.24)"
  } ]
}

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

    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();
        ListVulHostAppsRequest request = new ListVulHostAppsRequest();
        request.withHostId("{host_id}");
        try {
            ListVulHostAppsResponse response = client.listVulHostApps(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
# 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 = ListVulHostAppsRequest()
        request.host_id = "{host_id}"
        response = client.list_vul_host_apps(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
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.ListVulHostAppsRequest{}
	request.HostId = "{host_id}"
	response, err := client.ListVulHostApps(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.