Updated on 2025-09-08 GMT+08:00

Editing a Custom Scan Policy

Function

This API is used to edit a custom scan policy.

Calling Method

For details, see Calling APIs.

URI

PUT /v5/{project_id}/antivirus/policy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

policy_id

Yes

String

Policy ID

policy_name

Yes

String

Policy name

start_type

Yes

String

Start type. Its value can be:

  • now

  • later

  • period

scan_period

No

String

Start type. Its value can be:

  • day: every day

  • week: weekly

  • month: every month

scan_period_date

No

Integer

Scan period date. (1-28) When the scan period is week, 1-7 indicates Sunday to Saturday. When the scan period is month, 1-28 indicates the first day to 28th day of each month.

scan_time

No

Integer

Scan timestamp, in milliseconds. (This parameter is valid only when the startup type is later.)

scan_hour

No

Integer

Scan hours (The parameter is available only when the startup type is period.)

scan_minute

No

Integer

Scan minutes (This parameter is valid only when the startup type is period.)

timezone_offset

No

Integer

Time zone offset (unit: minute). This parameter is valid only when the start type is period.

file_types

Yes

Array of integers

File type. The options are as follows:

  • 0: all

  • 1: executable

  • 2: compression

  • 3: script

  • 4: document

  • 5: image

  • 6: audio and video

scan_dir

No

String

Scan directories. Use semicolons (;) to separate multiple directories.

ignore_dir

No

String

Excluded directories. Use semicolons (;) to separate multiple directories.

action

Yes

String

Handling mode. It can be:

  • auto: automatic handling

  • manual: manual handling

whether_paid_task

Yes

Boolean

Whether the scan task consumes the pay-per-use quota

host_ids

Yes

Array of strings

Policy management server list

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Edit a custom scan policy. Set the policy name to eb6cdfe6-daf6-4fef-8b63-9332b47e2885, file type to 1234, scan directory to /root, excluded directory to empty, handling action to automatic handling, server list to 0407b315-4a32-4dca-962e-abfead700ff6, start type to periodic scan by day, and start type to xx. The scan task does not consume the pay-per-use quota.

{
  "policy_id" : "eb6cdfe6-daf6-4fef-8b63-9332b47e2885",
  "policy_name" : "Custom scan - 20250416174856",
  "file_types" : [ 1, 2, 3, 4 ],
  "scan_dir" : "/root",
  "ignore_dir" : "",
  "action" : "manual",
  "host_ids" : [ "0407b315-4a32-4dca-962e-abfead700ff6" ],
  "whether_paid_task" : false,
  "scan_period" : "day",
  "scan_hour" : 0,
  "scan_minute" : 0,
  "timezone_offset" : -480,
  "start_type" : "period"
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Edit a custom scan policy. Set the policy name to eb6cdfe6-daf6-4fef-8b63-9332b47e2885, file type to 1234, scan directory to /root, excluded directory to empty, handling action to automatic handling, server list to 0407b315-4a32-4dca-962e-abfead700ff6, start type to periodic scan by day, and start type to xx. The scan task does not consume the pay-per-use quota.

 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
61
62
63
64
65
66
67
68
69
70
71
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 ChangeAntivirusPolicySolution {

    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();
        ChangeAntivirusPolicyRequest request = new ChangeAntivirusPolicyRequest();
        ChangeAntivirusPolicyRequestInfo body = new ChangeAntivirusPolicyRequestInfo();
        List<String> listbodyHostIds = new ArrayList<>();
        listbodyHostIds.add("0407b315-4a32-4dca-962e-abfead700ff6");
        List<Integer> listbodyFileTypes = new ArrayList<>();
        listbodyFileTypes.add(1);
        listbodyFileTypes.add(2);
        listbodyFileTypes.add(3);
        listbodyFileTypes.add(4);
        body.withHostIds(listbodyHostIds);
        body.withWhetherPaidTask(false);
        body.withAction("manual");
        body.withIgnoreDir("");
        body.withScanDir("/root");
        body.withFileTypes(listbodyFileTypes);
        body.withTimezoneOffset(-480);
        body.withScanMinute(0);
        body.withScanHour(0);
        body.withScanPeriod("day");
        body.withStartType("period");
        body.withPolicyName("Custom scan - 20250416174856");
        body.withPolicyId("eb6cdfe6-daf6-4fef-8b63-9332b47e2885");
        request.withBody(body);
        try {
            ChangeAntivirusPolicyResponse response = client.changeAntivirusPolicy(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());
        }
    }
}

Edit a custom scan policy. Set the policy name to eb6cdfe6-daf6-4fef-8b63-9332b47e2885, file type to 1234, scan directory to /root, excluded directory to empty, handling action to automatic handling, server list to 0407b315-4a32-4dca-962e-abfead700ff6, start type to periodic scan by day, and start type to xx. The scan task does not consume the pay-per-use quota.

 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
# 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 = ChangeAntivirusPolicyRequest()
        listHostIdsbody = [
            "0407b315-4a32-4dca-962e-abfead700ff6"
        ]
        listFileTypesbody = [
            1,
            2,
            3,
            4
        ]
        request.body = ChangeAntivirusPolicyRequestInfo(
            host_ids=listHostIdsbody,
            whether_paid_task=False,
            action="manual",
            ignore_dir="",
            scan_dir="/root",
            file_types=listFileTypesbody,
            timezone_offset=-480,
            scan_minute=0,
            scan_hour=0,
            scan_period="day",
            start_type="period",
            policy_name="Custom scan - 20250416174856",
            policy_id="eb6cdfe6-daf6-4fef-8b63-9332b47e2885"
        )
        response = client.change_antivirus_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)

Edit a custom scan policy. Set the policy name to eb6cdfe6-daf6-4fef-8b63-9332b47e2885, file type to 1234, scan directory to /root, excluded directory to empty, handling action to automatic handling, server list to 0407b315-4a32-4dca-962e-abfead700ff6, start type to periodic scan by day, and start type to xx. The scan task does not consume the pay-per-use quota.

 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
61
62
63
64
65
66
67
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.ChangeAntivirusPolicyRequest{}
	var listHostIdsbody = []string{
        "0407b315-4a32-4dca-962e-abfead700ff6",
    }
	var listFileTypesbody = []int32{
        int32(1),
	    int32(2),
	    int32(3),
	    int32(4),
    }
	ignoreDirChangeAntivirusPolicyRequestInfo:= ""
	scanDirChangeAntivirusPolicyRequestInfo:= "/root"
	timezoneOffsetChangeAntivirusPolicyRequestInfo:= int32(-480)
	scanMinuteChangeAntivirusPolicyRequestInfo:= int32(0)
	scanHourChangeAntivirusPolicyRequestInfo:= int32(0)
	scanPeriodChangeAntivirusPolicyRequestInfo:= "day"
	request.Body = &model.ChangeAntivirusPolicyRequestInfo{
		HostIds: listHostIdsbody,
		WhetherPaidTask: false,
		Action: "manual",
		IgnoreDir: &ignoreDirChangeAntivirusPolicyRequestInfo,
		ScanDir: &scanDirChangeAntivirusPolicyRequestInfo,
		FileTypes: listFileTypesbody,
		TimezoneOffset: &timezoneOffsetChangeAntivirusPolicyRequestInfo,
		ScanMinute: &scanMinuteChangeAntivirusPolicyRequestInfo,
		ScanHour: &scanHourChangeAntivirusPolicyRequestInfo,
		ScanPeriod: &scanPeriodChangeAntivirusPolicyRequestInfo,
		StartType: "period",
		PolicyName: "Custom scan - 20250416174856",
		PolicyId: "eb6cdfe6-daf6-4fef-8b63-9332b47e2885",
	}
	response, err := client.ChangeAntivirusPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.