查询主机视图下的主机漏洞信息 - ListVulHostHosts
功能介绍
查询主机视图下的主机漏洞信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/vulnerability/host/hosts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
是 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 不涉及 |
|
asset_value |
否 |
String |
参数解释: 资产重要性 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
group_name |
否 |
String |
参数解释: 服务器组 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
host_name |
否 |
String |
参数解释: 主机名称 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
public_ip |
否 |
String |
参数解释: 主机公有ip 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
private_ip |
否 |
String |
参数解释: 主机私有ip 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
severity_level |
否 |
String |
参数解释: 主机风险等级 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
handle_status |
否 |
String |
参数解释: 主机的处置状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
status |
否 |
String |
参数解释: 该漏洞状态包含的主机 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
cluster_id |
否 |
String |
参数解释: 集群id 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0,最大值2147483647 |
|
data_list |
Array of data_list objects |
参数解释: 主机信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
参数解释: 主机id 取值范围: 字符长度0-64位 |
|
agent_id |
String |
参数解释: agent id 取值范围: 字符长度0-64位 |
|
host_name |
String |
参数解释: 主机名称 取值范围: 字符长度0-64位 |
|
region_name |
String |
参数解释: 地域 取值范围: 字符长度0-32位 |
|
public_ip |
String |
参数解释: 服务器公网ip 取值范围: 字符长度0-128位 |
|
private_ip |
String |
参数解释: 服务器私网ip 取值范围: 字符长度0-4096位 |
|
group_id |
String |
参数解释: 服务器组id 取值范围: 字符长度0-128位 |
|
group_name |
String |
参数解释: 服务器组名称 取值范围: 字符长度0-256位 |
|
os_type |
String |
参数解释: 操作系统类型 取值范围:
|
|
asset_value |
String |
参数解释: 资产重要性 取值范围: 字符长度0-32位 |
|
scan_time |
Long |
参数解释: 最近扫描时间 取值范围: 最小值0,最大值2^63-1 |
|
severity_level |
String |
参数解释: 主机风险 取值范围: 字符长度0-32位 |
|
score |
Integer |
参数解释: 主机风险分数 取值范围: 最小值0,最大值100 |
|
version |
String |
参数解释: 主机配额 取值范围: 字符长度0-64位 |
|
handle_status |
String |
参数解释: 主机配额 取值范围:
|
|
vul_num_with_repair_priority_list |
Array of vul_num_with_repair_priority_list objects |
参数解释: 各个漏洞修复优先级下的漏洞数量 |
|
vul_ids_info |
vul_ids_info object |
参数解释: 各漏洞类型漏洞id列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
repair_priority |
String |
参数解释: 漏洞修复优先级 取值范围: 字符长度0-64位 |
|
vul_num |
Integer |
参数解释: 该优先级下的漏洞数量 取值范围: 最小值0,最大值2147483647 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
linux_vul_id_list |
Array of strings |
参数解释: Linux漏洞的漏洞id列表 |
|
windows_vul_id_list |
Array of strings |
参数解释: Windows漏洞的漏洞id列表 |
|
webcms_vul_id_list |
Array of strings |
参数解释: Web-CMS漏洞的漏洞id列表 |
|
app_vul_id_list |
Array of strings |
参数解释: 应用漏洞的漏洞id列表 |
|
urgent_vul_id_list |
Array of strings |
参数解释: 应急漏洞的漏洞id列表 |
请求示例
查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的主机视图下的漏洞主机列表。
GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/host/hosts?handle_status=unhandled&offset=0&limit=100&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"version" : "hss.version.premium",
"host_id" : "17300e07-da2a-4d74-87c5-b6fad8a18704",
"agent_id" : "5388b0d5f5c631e0584cbaad9d2e55ab77f1460fe9d9ffc90cfe578354411717",
"host_name" : "ecs-00896674",
"asset_value" : "common",
"scan_time" : 176153356425,
"os_type" : "Linux",
"private_ip" : "192.168.0.217",
"public_ip" : "100.93.7.22",
"region_name" : "cn-north-7",
"severity_level" : "Medium",
"score" : 73,
"vul_num_with_repair_priority_list" : [ {
"repair_priority" : "Critical",
"vul_num" : 0
}, {
"repair_priority" : "High",
"vul_num" : 4
}, {
"repair_priority" : "Medium",
"vul_num" : 12
}, {
"repair_priority" : "Low",
"vul_num" : 3
} ],
"vul_ids_info" : {
"linux_vul_id_list" : [ "EulerOS-SA-2025-1049", "EulerOS-SA-2025-1053", "EulerOS-SA-2025-1054", "EulerOS-SA-2025-1057" ],
"windows_vul_id_list" : [ "KB5053594" ],
"webcms_vul_id_list" : [ "HCVD-WEBCMS-2025-111111" ],
"app_vul_id_list" : [ "HCVD-APP-CVE-2025-24813" ],
"urgent_vul_id_list" : [ "URGENT-CVE-2021-44228" ]
},
"handle_status" : "unhandled"
} ]
}
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 |
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 ListVulHostHostsSolution { 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(); ListVulHostHostsRequest request = new ListVulHostHostsRequest(); try { ListVulHostHostsResponse response = client.listVulHostHosts(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 = ListVulHostHostsRequest() response = client.list_vul_host_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.ListVulHostHostsRequest{} response, err := client.ListVulHostHosts(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。