Updated on 2025-12-18 GMT+08:00

Disabling an Alert Rule

Function

This API is used to disable an alert rule.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/disable

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain the token by calling the IAM API used to obtain a user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of strings

Request for disabling an alert rule.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Task trace request ID.

Table 5 Response body parameters

Parameter

Type

Description

fail_list

Array of AlertRule objects

Failure list.

success_list

Array of AlertRule objects

Success list.

Table 6 AlertRule

Parameter

Type

Description

create_by

String

Creator.

create_time

Long

Creation time.

custom_properties

Map<String,String>

Custom extension information.

delete_time

Long

Deletion time.

event_grouping

Boolean

Alert group.

pipe_id

String

Data pipeline ID.

pipe_name

String

Data pipeline name.

query

String

Query statement.

query_type

String

Definition

Query syntax type.

  • SQL query

  • SQL

Constraints

N/A

Range

Default Value

SQL

rule_id

String

Alert rule ID.

rule_name

String

Alert rule name.

schedule

Schedule object

Scheduling rule.

severity

String

Definition

Status.

  • TIPS: informational

  • LOW: low risk

  • MEDIUM: medium risk

  • HIGH: high risk

  • FATAL: critical

  • TIPS

  • LOW

  • MEDIUM

  • HIGH

  • FATAL

  • MEDIUM

Constraints

N/A

Range

Default Value

status

String

Definition

Status.

  • ENABLED: enabled

  • DISABLED: disabled

Constraints

N/A

Range

  • ENABLED

  • DISABLED

Default Value

N/A

triggers

Array of AlertRuleTrigger objects

Alert triggering rules.

update_by

String

Updater.

update_time

Long

Update time.

Table 7 Schedule

Parameter

Type

Description

delay_interval

Integer

Delay interval.

frequency_interval

Integer

Scheduling interval.

frequency_unit

String

Definition

Scheduling interval unit.

  • MINUTE10: 10 minutes

  • HOUR: Hourly

  • DAY: daily

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

Default Value

N/A

overtime_interval

Integer

Timeout Interval.

period_interval

Integer

Time window interval.

period_unit

String

Definition

Time window unit.

  • MINUTE10: 10 minutes

  • HOUR: Hourly

  • DAY: daily

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

Default Value

N/A

Table 8 AlertRuleTrigger

Parameter

Type

Description

accumulated_times

Integer

Accumulated times.

expression

String

Expression.

mode

String

Definition

Metric mode.

  • COUNT: Number of counts

Constraints

N/A

Range

  • COUNT

Default Value

N/A

operator

String

Definition

Operator type.

  • GT: greater than

  • LT: less than

  • EQ: equal to

  • NE: not equal to

Constraints

N/A

Range

  • GT

  • LT

  • EQ

  • NE

Default Value

N/A

severity

String

Definition

Alert severity.

  • TIPS: informational

  • LOW: low risk

  • MEDIUM: medium risk

  • HIGH: high risk

  • FATAL: critical

Constraints

N/A

Range

  • TIPS

  • LOW

  • MEDIUM

  • HIGH

  • FATAL

Default Value

N/A

Status code: 400

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

Task trace request ID.

Example Requests

Disable an alert rule. Rule ID: 123123.

[ "123123" ]

Example Responses

Status code: 200

Request succeeded.

{
  "fail_list" : [ ],
  "success_list" : [ ]
}

SDK Sample Code

The SDK sample code is as follows.

Disable an alert rule. Rule ID: 123123.

 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
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.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;

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

public class DisableAlertRuleSolution {

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

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        DisableAlertRuleRequest request = new DisableAlertRuleRequest();
        request.withWorkspaceId("{workspace_id}");
        List<String> listbodyBody = new ArrayList<>();
        listbodyBody.add("123123");
        request.withBody(listbodyBody);
        try {
            DisableAlertRuleResponse response = client.disableAlertRule(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());
        }
    }
}

Disable an alert rule. Rule ID: 123123.

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DisableAlertRuleRequest()
        request.workspace_id = "{workspace_id}"
        listBodybody = [
            "123123"
        ]
        request.body = listBodybody
        response = client.disable_alert_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)

Disable an alert rule. Rule ID: 123123.

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

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

    request := &model.DisableAlertRuleRequest{}
	request.WorkspaceId = "{workspace_id}"
	var listBodybody = []string{
        "123123",
    }
	request.Body = &listBodybody
	response, err := client.DisableAlertRule(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.

400

Request failed.

Error Codes

See Error Codes.