文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 查询漏洞扫描任务对应的主机列表 - ListVulScanTaskHost
更新时间:2025-12-26 GMT+08:00
分享

查询漏洞扫描任务对应的主机列表 - ListVulScanTaskHost

功能介绍

查询漏洞扫描任务对应的主机列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/vulnerability/scan-task/{task_id}/hosts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

task_id

String

参数解释:

漏洞扫描任务id

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

scan_status

String

参数解释:

漏洞扫描任务的状态

约束限制:

不涉及

取值范围:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Long

参数解释:

总数

取值范围:

取值0-2147483647

data_list

Array of VulScanTaskHostInfo objects

参数解释:

漏洞扫描任务对应的主机列表

取值范围:

最小值0,最大值2147483647

表5 VulScanTaskHostInfo

参数

参数类型

描述

host_id

String

参数解释:

主机ID

取值范围:

字符长度1-128位

host_name

String

参数解释:

主机名称

取值范围:

字符长度0-128位

public_ip

String

参数解释:

弹性公网IP地址

取值范围:

字符长度0-128位

private_ip

String

参数解释:

私有IP地址

取值范围:

字符长度0-128位

asset_value

String

参数解释:

主机的资产重要性

取值范围:

  • important:重要资产

  • common:一般资产

  • test:测试资产

scan_status

String

参数解释:

主机的扫描状态

取值范围:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

failed_reasons

Array of failed_reasons objects

参数解释:

漏洞扫描失败的原因列表(即将废弃,建议使用“vul_scan_details”字段)

取值范围:

最小值0,最大值2147483647

vul_scan_details

Array of vul_scan_details objects

参数解释:

该主机的扫描详情信息列表

取值范围:

最小值0,最大值2147483647

表6 failed_reasons

参数

参数类型

描述

vul_type

String

参数解释:

扫描失败的漏洞类型

取值范围:

  • linux_vul:linux漏洞

  • windows_vul:windows漏洞

  • web_cms:Web-CMS漏洞

  • app_vul:应用漏洞

  • urgent_vul:应急漏洞

failed_reason

String

参数解释:

扫描失败的原因

取值范围:

字符长度0-128位

表7 vul_scan_details

参数

参数类型

描述

vul_type

String

参数解释:

扫描的漏洞类型

取值范围:

  • linux_vul:linux漏洞

  • windows_vul:windows漏洞

  • web_cms:Web-CMS漏洞

  • app_vul:应用漏洞

  • urgent_vul:应急漏洞

status

String

参数解释:

该类型漏洞的扫描状态

取值范围:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

failed_reason

String

参数解释:

扫描失败的原因,只有扫描失败的漏洞类型有该字段

取值范围:

字符长度0-1024位

scan_vul_list

Array of scan_vul_list objects

参数解释:

扫描的应急漏洞ID列表,只有漏洞类型为应急漏洞有该字段

取值范围:

最小值0,最大值2147483647

表8 scan_vul_list

参数

参数类型

描述

vul_id

String

参数解释:

漏洞id

取值范围:

字符长度0-256位

vul_name

String

参数解释:

漏洞名称

取值范围:

字符长度0-1024位

status

String

参数解释:

该漏洞的扫描状态

取值范围:

  • scanning:扫描中

  • success:扫描成功

  • failed:扫描失败

failed_reason

String

参数解释:

该漏洞扫描失败的原因,只有扫描失败的漏洞有该字段

取值范围:

字符长度0-1024位

请求示例

查询漏洞扫描任务id为2b31ed520xxxxxxebedb6e57xxxxxxxx详情信息,展示失败的主机列表,包含失败原因,默认查询第一页10条

GET https://{endpoint}/v5/{project_id}/vulnerability/scan-task/{task_id}/hosts?offset=0&limit=10&scan_status=failed&enterprise_project_id=XXX

{
  "scan_status" : "failed",
  "task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
}

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "host_name" : "ecs-ubuntu-abc123",
    "public_ip" : "112.10.10.3",
    "private_ip" : "192.168.10.1",
    "asset_value" : "important",
    "scan_status" : "failed",
    "failed_reasons" : [ {
      "vul_type" : "linux_vul",
      "failed_reason" : "this_is_failed_reason"
    } ],
    "vul_scan_details" : [ {
      "vul_type" : "linux_vul",
      "status" : "failed",
      "failed_reason" : "this_is_failed_reason"
    }, {
      "vul_type" : "urgent_vul",
      "status" : "scanning",
      "scan_vul_list" : [ {
        "vul_id" : "URGENT-CVE-2024-6387",
        "vul_name" : "OpenSSH 条件竞争漏洞( CVE-2024-6387)",
        "status" : "failed",
        "failed_reason" : "this_is_vul_failed_reason"
      }, {
        "vul_id" : "URGENT-CVE-2024-3094",
        "vul_name" : "XZ-Utils 5.6.0-5.6.1版本存在后门风险(CVE-2024-3094)",
        "status" : "scanning"
      } ]
    } ]
  } ]
}

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

    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();
        ListVulScanTaskHostRequest request = new ListVulScanTaskHostRequest();
        request.withTaskId("{task_id}");
        try {
            ListVulScanTaskHostResponse response = client.listVulScanTaskHost(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 = ListVulScanTaskHostRequest()
        request.task_id = "{task_id}"
        response = client.list_vul_scan_task_host(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.ListVulScanTaskHostRequest{}
	request.TaskId = "{task_id}"
	response, err := client.ListVulScanTaskHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档