Help Center/ Cloud Firewall/ API Reference/ API/ IPS Management/ Changing the IPS Rule Mode
Updated on 2025-01-03 GMT+08:00

Changing the IPS Rule Mode

Function

This API is used to change the IPS rule mode.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/ips-rule/mode

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

ips_ids

No

Array of strings

IPS ID list.

object_id

No

String

Protected object ID.

status

No

String

IPS rule status.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

IpsRuleChangeRespBody object

Table 6 IpsRuleChangeRespBody

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

group_id

String

Group ID.

id

String

Firewall ID.

ips_ids

Array of strings

IPS ID list.

result

Boolean

Modification result.

Example Requests

Change the IPS rule mode to OBSERVE.

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

{
  "object_id" : "1b90f031-0c7b-4f25-95e2-b6d9940d269e",
  "status" : "OBSERVE",
  "ips_ids" : [ "340724" ]
}

Example Responses

Status code: 200

OK

{
  "data" : {
    "group_id" : "e743cfaf-8164-4807-aa13-d893d83313cf",
    "id" : "e743cfaf-8164-4807-aa13-d893d83313cf",
    "ips_ids" : [ "340724" ],
    "result" : true
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

Change the IPS rule mode to OBSERVE.

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

    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();
        ChangeIpsRuleModeRequest request = new ChangeIpsRuleModeRequest();
        IpsRuleChangeDto body = new IpsRuleChangeDto();
        List<String> listbodyIpsIds = new ArrayList<>();
        listbodyIpsIds.add("340724");
        body.withStatus(IpsRuleChangeDto.StatusEnum.fromValue("OBSERVE"));
        body.withObjectId("1b90f031-0c7b-4f25-95e2-b6d9940d269e");
        body.withIpsIds(listbodyIpsIds);
        request.withBody(body);
        try {
            ChangeIpsRuleModeResponse response = client.changeIpsRuleMode(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());
        }
    }
}

Python

Change the IPS rule mode to OBSERVE.

 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
# 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 = ChangeIpsRuleModeRequest()
        listIpsIdsbody = [
            "340724"
        ]
        request.body = IpsRuleChangeDto(
            status="OBSERVE",
            object_id="1b90f031-0c7b-4f25-95e2-b6d9940d269e",
            ips_ids=listIpsIdsbody
        )
        response = client.change_ips_rule_mode(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Change the IPS rule mode to OBSERVE.

 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
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.ChangeIpsRuleModeRequest{}
	var listIpsIdsbody = []string{
        "340724",
    }
	statusIpsRuleChangeDto:= model.GetIpsRuleChangeDtoStatusEnum().OBSERVE
	objectIdIpsRuleChangeDto:= "1b90f031-0c7b-4f25-95e2-b6d9940d269e"
	request.Body = &model.IpsRuleChangeDto{
		Status: &statusIpsRuleChangeDto,
		ObjectId: &objectIdIpsRuleChangeDto,
		IpsIds: &listIpsIdsbody,
	}
	response, err := client.ChangeIpsRuleMode(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.