修改漏洞扫描策略 - ChangeVulScanPolicy
功能介绍
修改漏洞扫描策略。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v5/{project_id}/vulnerability/scan-policy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
scan_period |
是 |
String |
参数解释: 扫描周期 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
scan_range_type |
是 |
String |
参数解释: 扫描主机的范围 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
host_ids |
否 |
Array of strings |
参数解释: 主机ID列表; 约束限制: 当scan_range_type的值为specific_host时 表示扫描的主机列表 必填 取值范围: 最小值0,最大值20000 默认取值: 不涉及 |
|
scan_vul_types |
否 |
Array of strings |
参数解释: "扫描的漏洞类型列表" 约束限制: 不涉及 取值范围: 最小值0,最大值5 默认取值: 不涉及 |
|
status |
是 |
String |
参数解释: 扫描策略状态 约束限制: 不涉及 取值范围:
默认取值 : 不涉及 |
|
time |
否 |
time object |
参数解释: 扫描时间 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
day_part |
否 |
Array of integers |
参数解释: 扫描日期或者星期列表 约束限制: 不涉及 取值范围: 最小值0,最大值31 默认取值: 不涉及 |
|
hour_part |
否 |
Integer |
参数解释: 扫描时间的小时部分 约束限制: 不涉及 取值范围: 最小值0,最大值11 默认取值: 不涉及 |
|
minute_part |
否 |
Integer |
参数解释: 扫描时间的分钟部分 约束限制: 不涉及 取值范围: 最小值0,最大值59 默认取值: 不涉及 |
|
next_scan_time |
否 |
Long |
参数解释: 下一次扫描时间 约束限制: 不涉及 取值范围: 最小值0,最大值2^63-1 默认取值: 不涉及 |
|
timezone_offset |
否 |
Integer |
参数解释: 距离标准时区的差值,如东八区(GMT+8)为-480 约束限制: 不涉及 取值范围: 最小值-840,最大值720 默认取值: 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
修改漏洞扫描策略,扫描周期为每天,扫描范围为指定主机,指定的主机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代码示例如下。
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()); } } } |
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) |
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 |
请求已成功 |
错误码
请参见错误码。