文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 漏洞管理/ 添加漏洞白名单 - AddVulWhiteList
更新时间:2025-12-26 GMT+08:00
分享

添加漏洞白名单 - AddVulWhiteList

功能介绍

添加漏洞白名单。

调用方法

请参见如何调用API

授权信息

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

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

URI

POST /v5/{project_id}/vulnerability/white-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

vul_type

String

参数解释:

漏洞类型

约束限制:

不涉及

取值范围:

  • linux_vul:linux漏洞

  • windows_vul:windows漏洞

  • web_cms:Web-CMS漏洞

  • app_vul:应用漏洞

默认取值:

不涉及

vul_ids

Array of strings

参数解释:

漏洞ID列表

约束限制:

不涉及

取值范围:

最小值1,最大值500

默认取值:

不涉及

rule_type

String

参数解释:

白名单规则类型

约束限制:

不涉及

取值范围:

  • all_host:白名单应用于全部主机

  • specific_host:白名单应用于指定主机

默认取值:

不涉及

host_ids

Array of strings

参数解释:

主机ID列表,当rule_type为specific_host时,该字段必填

约束限制:

不涉及

取值范围:

最小值1,最大值2000

默认取值:

不涉及

with_ignore

Boolean

参数解释:

是否忽略当前已扫描出的漏洞

约束限制:

不涉及

取值范围:

  • true:忽略

  • false:不忽略

默认取值:

true

description

String

参数解释:

白名单的描述信息

约束限制:

不涉及

取值范围:

字符长度0-1000

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

新增漏洞白名单

POST https://{endpoint}/v5/{project_id}/vulnerability/white-list?enterprise_project_id=all_granted_eps

{
  "vul_type" : "linux_vul",
  "vul_ids" : [ "Alpinev3.10-main-apk-tools-2.10.7-r0" ],
  "rule_type" : "specific_host",
  "description" : "description",
  "host_ids" : [ "b5d8f811-1be6-4630-8312-8513860e02cc" ]
}

响应示例

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
49
50
51
52
53
54
55
56
57
58
59
60
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.*;

import java.util.List;
import java.util.ArrayList;

public class AddVulWhiteListSolution {

    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();
        AddVulWhiteListRequest request = new AddVulWhiteListRequest();
        AddVulWhiteListRequestBody body = new AddVulWhiteListRequestBody();
        List<String> listbodyHostIds = new ArrayList<>();
        listbodyHostIds.add("b5d8f811-1be6-4630-8312-8513860e02cc");
        List<String> listbodyVulIds = new ArrayList<>();
        listbodyVulIds.add("Alpinev3.10-main-apk-tools-2.10.7-r0");
        body.withDescription("description");
        body.withHostIds(listbodyHostIds);
        body.withRuleType("specific_host");
        body.withVulIds(listbodyVulIds);
        body.withVulType("linux_vul");
        request.withBody(body);
        try {
            AddVulWhiteListResponse response = client.addVulWhiteList(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
33
34
35
36
37
38
39
40
41
42
43
44
# 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 = AddVulWhiteListRequest()
        listHostIdsbody = [
            "b5d8f811-1be6-4630-8312-8513860e02cc"
        ]
        listVulIdsbody = [
            "Alpinev3.10-main-apk-tools-2.10.7-r0"
        ]
        request.body = AddVulWhiteListRequestBody(
            description="description",
            host_ids=listHostIdsbody,
            rule_type="specific_host",
            vul_ids=listVulIdsbody,
            vul_type="linux_vul"
        )
        response = client.add_vul_white_list(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
39
40
41
42
43
44
45
46
47
48
49
50
51
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.AddVulWhiteListRequest{}
	var listHostIdsbody = []string{
        "b5d8f811-1be6-4630-8312-8513860e02cc",
    }
	var listVulIdsbody = []string{
        "Alpinev3.10-main-apk-tools-2.10.7-r0",
    }
	descriptionAddVulWhiteListRequestBody:= "description"
	request.Body = &model.AddVulWhiteListRequestBody{
		Description: &descriptionAddVulWhiteListRequestBody,
		HostIds: &listHostIdsbody,
		RuleType: "specific_host",
		VulIds: listVulIdsbody,
		VulType: "linux_vul",
	}
	response, err := client.AddVulWhiteList(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档