更新时间:2024-11-19 GMT+08:00

修改漏洞扫描策略

功能介绍

修改漏洞扫描策略

调用方法

请参见如何调用API

URI

PUT /v5/{project_id}/vulnerability/scan-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业租户ID,注:修改漏洞扫描策略将影响租户账号下所有主机的漏洞扫描行为,因此开通了多企业项目的用户,该参数须填写“all_granted_eps”才能执行漏洞策略修改。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

scan_period

String

扫描周期

  • one_day : 每天

  • three_day : 每三天

  • one_week : 每周

scan_range_type

String

扫描主机的范围,包含如下:

-all_host : 扫描全部主机

-specific_host : 扫描指定主机

host_ids

Array of strings

主机ID列表;当scan_range_type的值为specific_host时必填

scan_vul_types

Array of strings

扫描的漏洞类型列表

status

String

扫描策略状态,包含如下:

-open : 开启

-close : 关闭

响应参数

请求示例

修改漏洞扫描策略,扫描周期为每天,扫描范围为指定主机,指定的主机id为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,策略状态为开启

PUT https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/scan-policy?enterprise_project_id=all_granted_eps

{
  "scan_period" : "one_day",
  "scan_range_type" : "specific_host",
  "host_ids" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ],
  "status" : "open"
}

响应示例

SDK代码示例

SDK代码示例如下。

修改漏洞扫描策略,扫描周期为每天,扫描范围为指定主机,指定的主机id为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,策略状态为开启

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

    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();
        ChangeVulScanPolicyRequest request = new ChangeVulScanPolicyRequest();
        ChangeVulScanPolicyRequestInfo body = new ChangeVulScanPolicyRequestInfo();
        List<String> listbodyHostIds = new ArrayList<>();
        listbodyHostIds.add("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
        body.withStatus("open");
        body.withHostIds(listbodyHostIds);
        body.withScanRangeType("specific_host");
        body.withScanPeriod("one_day");
        request.withBody(body);
        try {
            ChangeVulScanPolicyResponse response = client.changeVulScanPolicy(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());
        }
    }
}

修改漏洞扫描策略,扫描周期为每天,扫描范围为指定主机,指定的主机id为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,策略状态为开启

 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
# 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 = ChangeVulScanPolicyRequest()
        listHostIdsbody = [
            "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        ]
        request.body = ChangeVulScanPolicyRequestInfo(
            status="open",
            host_ids=listHostIdsbody,
            scan_range_type="specific_host",
            scan_period="one_day"
        )
        response = client.change_vul_scan_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

修改漏洞扫描策略,扫描周期为每天,扫描范围为指定主机,指定的主机id为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,策略状态为开启

 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
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.ChangeVulScanPolicyRequest{}
	var listHostIdsbody = []string{
        "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    }
	request.Body = &model.ChangeVulScanPolicyRequestInfo{
		Status: "open",
		HostIds: &listHostIdsbody,
		ScanRangeType: "specific_host",
		ScanPeriod: "one_day",
	}
	response, err := client.ChangeVulScanPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

successful response

错误码

请参见错误码