Updated on 2025-06-10 GMT+08:00

Modifying an Antivirus Rule

Function

This API is used to modify an antivirus rule.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/anti-virus/rule

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by calling an API or from the console. You can obtain it by referring to Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by referring to Obtaining a User Token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

object_id

Yes

String

Protected object ID.

scan_protocol_configs

Yes

Array of ScanProtocolConfig objects

Scan the protocol configuration list.

Table 5 ScanProtocolConfig

Parameter

Mandatory

Type

Description

action

Yes

Integer

Antivirus action: 0 (observe), 1 (block), or 2 (disable).

protocol_type

Yes

Integer

Protocol type. The value can be 0** (HTTP), 1 (SMTP), 2 (POP3), 3 (IMAP4), 4 (FTP), 5 (SMB), 6 (malicious access), or 7 (IM).

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

data

ResponseData object

Return value for updating the antivirus rule list.

Table 7 ResponseData

Parameter

Type

Description

id

String

Data ID.

Example Requests

Change the antivirus rule to Observe for the project whose ID is 408972e72dcd4c1a9b033e955802a36b, firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4.

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/anti-virus/rule?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4

{
  "object_id" : "1b90f031-0c7b-4f25-95e2-b6d9940d269e",
  "scan_protocol_configs" : [ {
    "protocol_type" : 2,
    "action" : 0
  } ]
}

Example Responses

Status code: 200

Return value for updating the antivirus rule.

{
  "data" : {
    "id" : "1b90f031-0c7b-4f25-95e2-b6d9940d269e"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Change the antivirus rule to Observe for the project whose ID is 408972e72dcd4c1a9b033e955802a36b, firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4.

 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
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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;

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

public class UpdateAntiVirusRuleSolution {

    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);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateAntiVirusRuleRequest request = new UpdateAntiVirusRuleRequest();
        AntiVirusRuleDto body = new AntiVirusRuleDto();
        List<ScanProtocolConfig> listbodyScanProtocolConfigs = new ArrayList<>();
        listbodyScanProtocolConfigs.add(
            new ScanProtocolConfig()
                .withAction(0)
                .withProtocolType(2)
        );
        body.withScanProtocolConfigs(listbodyScanProtocolConfigs);
        body.withObjectId("1b90f031-0c7b-4f25-95e2-b6d9940d269e");
        request.withBody(body);
        try {
            UpdateAntiVirusRuleResponse response = client.updateAntiVirusRule(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());
        }
    }
}

Change the antivirus rule to Observe for the project whose ID is 408972e72dcd4c1a9b033e955802a36b, firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 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 = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateAntiVirusRuleRequest()
        listScanProtocolConfigsbody = [
            ScanProtocolConfig(
                action=0,
                protocol_type=2
            )
        ]
        request.body = AntiVirusRuleDto(
            scan_protocol_configs=listScanProtocolConfigsbody,
            object_id="1b90f031-0c7b-4f25-95e2-b6d9940d269e"
        )
        response = client.update_anti_virus_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Change the antivirus rule to Observe for the project whose ID is 408972e72dcd4c1a9b033e955802a36b, firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/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 := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateAntiVirusRuleRequest{}
	actionScanProtocolConfigs:= int32(0)
	protocolTypeScanProtocolConfigs:= int32(2)
	var listScanProtocolConfigsbody = []model.ScanProtocolConfig{
        {
            Action: &actionScanProtocolConfigs,
            ProtocolType: &protocolTypeScanProtocolConfigs,
        },
    }
	objectIdAntiVirusRuleDto:= "1b90f031-0c7b-4f25-95e2-b6d9940d269e"
	request.Body = &model.AntiVirusRuleDto{
		ScanProtocolConfigs: &listScanProtocolConfigsbody,
		ObjectId: &objectIdAntiVirusRuleDto,
	}
	response, err := client.UpdateAntiVirusRule(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

Return value for updating the antivirus rule.

401

Unauthorized: Request error.

403

Forbidden: Access forbidden.

404

Not Found: Web page not found.

Error Codes

See Error Codes.