文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 查询受影响服务器详情-软件列表
更新时间:2025-08-29 GMT+08:00
分享

查询受影响服务器详情-软件列表

功能介绍

查询受影响服务器详情-软件列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

host_id

String

参数解释:

主机id

约束限制:

不涉及

取值范围:

字符长度1-128

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

vul_id

String

参数解释:

漏洞ID

约束限制:

不涉及

取值范围:

字符长度0-256位

默认取值:

不涉及

handle_status

String

参数解释:

漏洞处置状态

约束限制:

不涉及

取值范围:

  • handled : 已处理

  • unhandled : 未处理

默认取值:

不涉及

container_id

String

参数解释:

存在漏洞的容器ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

is_container

Boolean

参数解释:

是否是容器场景

约束限制:

不涉及

取值范围:

  • true:是容器场景

  • false:不是容器场景

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of data_list objects

参数解释:

软件信息列表

取值范围:

不涉及

total_num

Integer

参数解释:

总数

取值范围:

取值0-2147483647

表5 data_list

参数

参数类型

描述

app_name

String

参数解释:

app名称

取值范围:

字符长度1-128位

path

String

参数解释:

存在漏洞的软件路径,仅应用漏洞、应急漏洞等存在软件路径的漏洞类型查询时存在该字段(注:该字段即将弃用,请使用paths字段获取软件路径相关信息)

取值范围:

字符长度1-512位

paths

Array of paths objects

参数解释:

存在漏洞的软件路径列表,仅应用漏洞、应急漏洞等存在软件路径的漏洞类型查询时存在该字段

取值范围:

不涉及

rule

String

参数解释:

软件命中的漏洞匹配规则

取值范围:

字符长度1-512位

表6 paths

参数

参数类型

描述

app_path

String

参数解释:

存在漏洞的软件路径

取值范围:

字符长度1-512位

app_version

String

参数解释:

软件版本

取值范围:

字符长度1-64位

status

String

参数解释:

漏洞状态

取值范围:

  • vul_status_unfix:未处理

  • vul_status_ignored:已忽略

  • vul_status_verified:验证中

  • vul_status_fixing:修复中

  • vul_status_fixed:修复成功

  • vul_status_reboot:修复成功待重启

  • vul_status_failed:修复失败

  • vul_status_fix_after_reboot:请重启主机再次修复

请求示例

响应示例

状态码:200

请求已成功

{
  "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代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档