统计受影响服务器和漏洞数量 - ShowVulAffectedStatics
功能介绍
统计受影响服务器和漏洞数量。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/vulnerability/statistics/affected
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
select_type |
否 |
String |
参数解释: 选择全部漏洞类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
type |
否 |
String |
参数解释: 漏洞类型,当前select_type为all_vul此字段为必选 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
cluster_id |
否 |
String |
参数解释: 集群id 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
|
container_ids |
否 |
Array of strings |
参数解释: 容器id集合 约束限制: 不涉及 取值范围: 最小值1,最大值1000 默认取值: 不涉及 |
|
is_container |
否 |
Boolean |
参数解释: 是否是容器场景 约束限制: 不涉及 取值范围:
默认取值: false |
|
vul_ids |
否 |
Array of strings |
参数解释: 漏洞id集合 约束限制: 不涉及 取值范围: 最小值1,最大值1000 默认取值: 不涉及 |
|
host_ids |
否 |
Array of strings |
参数解释: 主机id集合 约束限制: 不涉及 取值范围: 最小值1,最大值1000 默认取值: 不涉及 |
|
category |
否 |
String |
参数解释: 类别,默认为host 约束限制: 不涉及 取值范围:
默认取值: host |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vul_num |
Integer |
参数解释: 影响的漏洞数量(按漏洞编号计算) 取值范围: 最小值0,最大值2147483647 |
|
host_num |
Integer |
参数解释: 影响主机数量 取值范围: 最小值0,最大值2147483647 |
|
image_num |
Integer |
参数解释: 影响镜像数量 取值范围: 最小值0,最大值2147483647 |
|
container_num |
Integer |
参数解释: 影响容器数量 取值范围: 最小值0,最大值2147483647 |
|
data_list |
Array of data_list objects |
参数解释: 按漏洞类型的统计值,当select_type为all_host或空时,有该字段 |
|
total_vul_num |
Integer |
参数解释: 影响的总漏洞条数(主机+漏洞 以此维度计算) 取值范围: 最小值0,最大值2147483647 |
|
extend_tips |
Array of strings |
参数解释: 提示 |
|
extend_text_tips |
Array of strings |
参数解释: 漏洞修复提示 取值范围: 最小值1,最大值500 |
|
disabled_operate_types |
disabled_operate_types object |
参数解释: 禁用的漏洞操作类型列表 |
|
cce_vul_num |
Integer |
参数解释: CCE漏洞数量 取值范围: 最小值0,最大值2147483647 |
|
basic_host_num |
Integer |
参数解释: 基础版主机数量 取值范围: 最小值0,最大值2147483647 |
|
cce_disabled_vul_list |
Array of cce_disabled_vul_list objects |
参数解释: CCE主机漏洞禁止修复列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释: 漏洞类型 取值范围:
|
|
vul_num |
Integer |
参数解释: 该漏洞类型的漏洞数量 取值范围: 最小值0,最大值2147483647 |
请求示例
查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx,主机id为cb193cfc-671a-4be6-bdcf-e0761d5ab734在进行漏洞操作时(修复)会影响的漏洞范围。
GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/statistics/affected?handle_status=unhandled&statistic_basic=false&operate_type=immediate_repair&host_ids=cb193cfc-671a-4be6-bdcf-e0761d5ab734&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"vul_num" : 92,
"host_num" : 1,
"total_vul_num" : 92,
"data_list" : [ {
"type" : "linux_vul",
"vul_num" : 92
}, {
"type" : "windows_vul",
"vul_num" : 0
}, {
"type" : "web_cms",
"vul_num" : 0
}, {
"type" : "app_vul",
"vul_num" : 0
}, {
"type" : "urgent_vul",
"vul_num" : 0
}, {
"type" : "cluster_vul",
"vul_num" : 0
} ],
"extend_tips" : [ ],
"extend_text_tips" : [ ],
"disabled_operate_types" : {
"operate_type" : "xxx",
"reason" : "xxx"
},
"cce_vul_num" : 2,
"cce_disabled_vul_list" : [ {
"host_name" : "ecs-yescrypt误删",
"host_id" : "cb193cfc-671a-4be6-bdcf-e0761d5ab734",
"vul_name" : "USN-7166-1: Linux kernel vulnerabilities",
"vul_id" : "USN-7166-1",
"operation_description" : "该软件是cce集群的核心依赖软件,自行升级后可能会导致cce功能异常,请勿自行升级。可以通过升级集群版本到最新版本后,再重置节点解决。如果集群版本已经是最新版本并且重置节点后仍然存在该漏洞,cce将按照华为云漏洞SLO在后续版本修复。漏洞修复策略参考:https://support.huaweicloud.com/bulletin-cce/cce_bulletin_0011.html。"
}, {
"host_name" : "ecs-yescrypt误删",
"host_id" : "cb193cfc-671a-4be6-bdcf-e0761d5ab734",
"vul_name" : "USN-7179-1: Linux kernel vulnerabilities",
"vul_id" : "USN-7179-1",
"operation_description" : "该软件是cce集群的核心依赖软件,自行升级后可能会导致cce功能异常,请勿自行升级。可以通过升级集群版本到最新版本后,再重置节点解决。如果集群版本已经是最新版本并且重置节点后仍然存在该漏洞,cce将按照华为云漏洞SLO在后续版本修复。漏洞修复策略参考:https://support.huaweicloud.com/bulletin-cce/cce_bulletin_0011.html。"
} ]
}
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 ShowVulAffectedStaticsSolution { 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(); ShowVulAffectedStaticsRequest request = new ShowVulAffectedStaticsRequest(); try { ShowVulAffectedStaticsResponse response = client.showVulAffectedStatics(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 = ShowVulAffectedStaticsRequest() response = client.show_vul_affected_statics(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.ShowVulAffectedStaticsRequest{} response, err := client.ShowVulAffectedStatics(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。