# 查询单个漏洞影响的云服务器信息 - ListVulHosts #### 功能介绍 查询单个漏洞影响的云服务器信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/vulnerability/hosts 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | | limit | 否 | Integer | **参数解释**: 每页显示个数 **约束限制**: 不涉及 **取值范围**: 取值10-200 **默认取值**: 10 | | offset | 否 | Integer | **参数解释**: 偏移量：指定返回记录的开始位置 **约束限制**: 不涉及 **取值范围**: 最小值0，最大值2000000 **默认取值**: 默认为0 | | host_name | 否 | String | **参数解释**: 服务器名称 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | | host_ip | 否 | String | **参数解释**: 服务器IP **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | | vul_id | 是 | String | **参数解释**: 漏洞ID **约束限制**: 不涉及 **取值范围**: 字符范围0-64 **默认取值**: 不涉及 | | type | 是 | String | **参数解释**: 查询的漏洞类型 **约束限制**: 不涉及 **取值范围**: - linux_vul : linux漏洞 - windows_vul : windows漏洞 - web_cms : Web-CMS漏洞 - app_vul : 应用漏洞 - urgent_vul : 应急漏洞 **默认取值**: 不涉及 | | 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 : 请重启主机再次修复 **默认取值**: 不涉及 | | asset_value | 否 | String | **参数解释**: 资产重要性 **约束限制**: 不涉及 **取值范围**: - important : 重要 - common : 一般 - test : 测试 **默认取值**: 不涉及 | | group_name | 否 | String | **参数解释**: 服务器组名称 **约束限制**: 不涉及 **取值范围**: 字符范围0-256位 **默认取值**: 不涉及 | | handle_status | 否 | String | **参数解释**: 漏洞当前的处置状态 **约束限制**: 不涉及 **取值范围**: - unhandled : 未处理 - handled : 已处理 **默认取值**: 不涉及 | | severity_level | 否 | String | **参数解释**: 危险程度（风险等级） **约束限制**: 不涉及 **取值范围**: - Critical：漏洞cvss评分大于等于9；对应控制台页面的高危 - High：漏洞cvss评分大于等于7，小于9；对应控制台页面的中危 - Medium：漏洞cvss评分大于等于4，小于7；对应控制台页面的中危 - Low：漏洞cvss评分小于4；对应控制台页面的低危 可用逗号连接作为多选 **默认取值**: 不涉及 | | is_affect_business | 否 | Boolean | **参数解释**: 是否影响业务 **约束限制**: 不涉及 **取值范围**: - true：影响业务 - false：不影响业务 **默认取值**: 不涉及 | | repair_priority | 否 | String | **参数解释**: 修复优先级 **约束限制**: 不涉及 **取值范围**: - Critical：紧急 - High：高危 - Medium：中危 - Low：低危 可用逗号连接作为多选 **默认取值**: 不涉及 | | cluster_name | 否 | String | **参数解释**: 集群名称。 **约束限制**: 不涉及 **取值范围**: 字符长度1-64。 **默认取值**: 不涉及 | | cluster_id | 否 | String | **参数解释**: 集群id **约束限制**: 不涉及 **取值范围**: 长度范围1-64位 **默认取值**: 不涉及 | | is_container | 否 | Boolean | **参数解释**: 是否是容器场景 **约束限制**: 不涉及 **取值范围**: - true：是容器场景 - false：不是容器场景 **默认取值**: false | | container_name | 否 | String | **参数解释**: 容器名称（容器场景生效） **约束限制**: 不涉及 **取值范围**: 字符长度0-128位 **默认取值**: 不涉及 | | min_scan_time | 否 | Long | **参数解释**： 扫描任务开始时间的最小值（容器场景生效） **约束限制**: 不涉及 **取值范围**： 最小值0，最大值2\^63-1 **默认取值**: 不涉及 | | max_scan_time | 否 | Long | **参数解释**： 扫描任务开始时间的最大值（容器场景生效） **约束限制**: 不涉及 **取值范围**： 最小值0，最大值2\^63-1 **默认取值**: 不涉及 | | node_type | 否 | String | **参数解释**: 节点类型 **约束限制**: 不涉及 **取值范围**: - cce：cce节点 - not_cce：非cce节点 字符长度0-256位 **默认取值**: 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释**: 受影响的云服务器总数 **取值范围**: 最小值0，最大值10000 | | data_list | Array of [VulHostInfo] objects | **参数解释**: 受影响的云服务器列表 **取值范围**: 最小值1，最大值10000 | 表5VulHostInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_id | String | **参数解释**: 受漏洞影响的服务器id **取值范围**: 字符范围1-128位 | | agent_id | String | **参数解释**: 主机对应的agent id **取值范围**: 字符范围1-128位 | | repair_necessity | String | **参数解释**: 修复紧急度 **取值范围**: - Critical：漏洞cvss评分大于等于9；对应控制台页面的高危 - High：漏洞cvss评分大于等于7，小于9；对应控制台页面的中危 - Medium：漏洞cvss评分大于等于4，小于7；对应控制台页面的中危 - Low：漏洞cvss评分小于4；对应控制台页面的低危 | | severity_level | String | **参数解释**: 危险程度 **取值范围**: - Critical：漏洞cvss评分大于等于9；对应控制台页面的高危 - High：漏洞cvss评分大于等于7，小于9；对应控制台页面的中危 - Medium：漏洞cvss评分大于等于4，小于7；对应控制台页面的中危 - Low：漏洞cvss评分小于4；对应控制台页面的低危 | | host_name | String | **参数解释**: 受影响主机名称 **取值范围**: 字符范围1-256位 | | host_ip | String | **参数解释**: 受影响主机ip **取值范围**: 字符范围1-256位 | | cve_num | Integer | **参数解释**: 漏洞cve总数 **取值范围**: 最小值0，最大值10000 | | cve_id_list | Array of strings | **参数解释**: 漏洞对应的cve id列表 **取值范围**: 最小值1，最大值10000 | | 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：请重启主机再次修复 | | remark | String | **参数解释**: 处置备注 **取值范围**: 字符长度1-65535位 | | repair_cmd | String | **参数解释**: 修复漏洞需要执行的命令行（只有Linux漏洞有该字段） **取值范围**: 字符范围1-256位 | | version | String | **参数解释**: 主机绑定的配额版本 **取值范围**: 字符范围1-128位 | | app_path | String | **参数解释**: 应用软件的路径（只有应用漏洞有该字段） **取值范围**: 字符范围1-512位 | | is_affect_business | Boolean | **参数解释**: 是否影响业务 **取值范围**: - true : 影响业务 - false : 不影响业务 | | asset_value | String | **参数解释**: 资产重要性 **取值范围**: - important : 重要资产 - common : 一般资产 - test : 测试资产 | | private_ip | String | **参数解释**: 服务器私网ip **取值范围**: 字符范围0-128位 | | group_name | String | **参数解释**: 服务器组名称 **取值范围**: 字符范围0-256位 | | group_id | String | **参数解释**: 服务器组id **取值范围**: 字符范围0-128位 | | os_type | String | **参数解释**: 操作系统类型 **取值范围**: - Linux ：linux系统 - Windows：windows系统 | | os_name | String | **参数解释**: 操作系统名称 **取值范围**: 字符长度1-256位 | | os_version | String | **参数解释**: 操作系统版本 **取值范围**: 字符长度1-255位 | | os_kernel | String | **参数解释**: 操作系统内核 **取值范围**: 字符长度1-64位 | | host_status | String | **参数解释**: 主机状态 **取值范围**: - ACTIVE：正在运行。 - SHUTOFF：关机。 - BUILDING：创建中。 - ERROR：故障。 | | first_scan_time | Long | **参数解释**: 首次扫描时间 **取值范围**: 最小值0，最大值9223372036854775807 | | scan_time | Long | **参数解释**: 扫描时间，时间戳单位：毫秒 **取值范围**: 最小值0，最大值9223372036854775807 | | failed_reason | String | **参数解释**: 修复失败原因 **取值范围**: 字符长度1-65535位 | | support_restore | Boolean | **参数解释**: 是否可以回滚到修复漏洞时创建的备份 **取值范围**: - true : 可以回滚 - false : 不可以回滚 | | backup_name | String | **参数解释**: 备份名称 **取值范围**: 字符长度1-2048位 | | agent_status | String | **参数解释**: Agent状态 **取值范围**: - installed：已安装。 - not_installed：未安装。 - online：在线。 - offline：离线。 - install_failed：安装失败。 - installing：安装中。 | | disabled_operate_types | Array of [disabled_operate_types] objects | **参数解释**: 漏洞在当前主机上不可进行的操作类型列表 **取值范围**: 最小值1，最大值10000 | | repair_priority | String | **参数解释**: 修复优先级 **取值范围**: - Critical : 紧急 - High : 高 - Medium : 中 - Low : 低 | | node_type | String | **参数解释**: 节点类型 **取值范围**: - cce：cce节点 - not_cce：非cce节点 字符长度0-256位 | 表6disabled_operate_types | 参数 | 参数类型 | 描述 | |:---|:---|:---| | operate_type | String | **参数解释**: 操作类型 **取值范围**: - ignore : 忽略 - not_ignore : 取消忽略 - immediate_repair : 修复 - manual_repair : 人工修复 - verify : 验证 - add_to_whitelist : 加入白名单 | | reason | String | **参数解释**: 不可进行操作的原因 **取值范围**: 字符范围0-512位 | #### 请求示例 查询具有漏洞EulerOS-SA-2021-1894的服务器列表的前10条数据 ``` GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/hosts?vul_id=EulerOS-SA-2021-1894&offset=0&limit=10 ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "total_num" : 1, "data_list" : [ { "host_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "severity_level" : "Critical", "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" : "cce机器的内核漏洞不支持自动修复" } ], "repair_priority" : "Critical", "is_affect_business" : false, "asset_value" : "common", "private_ip" : "192.168.0.25", "group_id" : "d9327506-5282-3017-9077-e385eacca1af", "group_name" : "test", "os_type" : "Linux", "os_name" : "EulerOS", "os_version" : "2.3", "os_kernel" : "3.10.0-514.44.5.10.h254.x86_64", "host_status" : "ACTIVE", "first_scan_time" : 1781536920340, "scan_time" : 1784040352038, "failed_reason" : "test", "backup_name" : "test", "agent_status" : "online", "node_type" : "not_cce" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListVulHostsRequest{} response, err := client.ListVulHosts(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListVulHosts&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。