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

Updating an Alert Rule

Function

This API is used to update an alert rule.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/{rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID.

rule_id

Yes

String

Alert rule 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

alert_type

No

Map<String,String>

Alert type, which is obtained through the API for querying the data class list.

custom_properties

No

Map<String,String>

Custom extension information.

description

No

String

Description.

event_grouping

No

Boolean

Alert group.

query

No

String

Query statement.

query_type

No

String

Definition

Query syntax type.

  • SQL query

  • SQL

Constraints

N/A

Range

Default Value

SQL

rule_name

No

String

Alert rule name.

schedule

No

Schedule object

Scheduling rule.

severity

No

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

simulation

No

Boolean

Simulated alerts.

status

No

String

Definition

Status.

  • ENABLED: enabled

  • DISABLED: disabled

Constraints

N/A

Range

  • ENABLED

  • DISABLED

Default Value

N/A

suppression

No

Boolean

Alert suppression.

triggers

No

Array of AlertRuleTrigger objects

Alert triggering rules.

Table 4 Schedule

Parameter

Mandatory

Type

Description

delay_interval

No

Integer

Delay interval.

frequency_interval

Yes

Integer

Scheduling interval.

frequency_unit

Yes

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

No

Integer

Timeout Interval.

period_interval

Yes

Integer

Time window interval.

period_unit

Yes

String

Definition

Time window unit.

  • MINUTE10: 10 minutes

  • HOUR: Hourly

  • DAY: daily

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

Default Value

N/A

Table 5 AlertRuleTrigger

Parameter

Mandatory

Type

Description

accumulated_times

No

Integer

Accumulated times.

expression

Yes

String

Expression.

mode

No

String

Definition

Metric mode.

  • COUNT: Number of counts

Constraints

N/A

Range

  • COUNT

Default Value

N/A

operator

No

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

No

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

Response Parameters

Status code: 200

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

Task trace request ID.

Table 7 Response body parameters

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 8 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 9 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 10 Response header parameters

Parameter

Type

Description

X-request-id

String

Task trace request ID.

Example Requests

Update an alert rule whose name is Alert rule, query type is SQL, status is Enabled, and Severity is Warning.

{
  "custom_properties" : {
    "maintainer" : "isap",
    "references" : "https://localhost/references"
  },
  "event_grouping" : true,
  "query" : "* | select status, count(*) as count group by status",
  "query_type" : "SQL",
  "rule_name" : "Alert rule",
  "schedule" : {
    "delay_interval" : 2,
    "frequency_interval" : 5,
    "frequency_unit" : "MINUTE",
    "overtime_interval" : 10,
    "period_interval" : 5,
    "period_unit" : "MINUTE"
  },
  "severity" : "TIPS",
  "status" : "ENABLED",
  "triggers" : [ {
    "expression" : 10,
    "mode" : "COUNT",
    "operator" : "GT",
    "severity" : "TIPS"
  } ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "create_by" : "582dd19dd99d4505a1d7929dc943b169",
  "create_time" : 1665221214,
  "custom_properties" : {
    "maintainer" : "isap",
    "references" : "https://localhost/references"
  },
  "delete_time" : 0,
  "event_grouping" : true,
  "pipe_id" : "772fb35b-83bc-46c9-a0b1-ebe31070a889",
  "query" : "* | select status, count(*) as count group by status",
  "query_type" : "SQL",
  "rule_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950",
  "rule_name" : "Alert rule",
  "schedule" : {
    "delay_interval" : 2,
    "frequency_interval" : 5,
    "frequency_unit" : "MINUTE",
    "overtime_interval" : 10,
    "period_interval" : 5,
    "period_unit" : "MINUTE"
  },
  "severity" : "TIPS",
  "status" : "ENABLED",
  "triggers" : [ {
    "expression" : 10,
    "mode" : "COUNT",
    "operator" : "GT",
    "severity" : "TIPS"
  } ],
  "update_by" : "582dd19dd99d4505a1d7929dc943b169",
  "update_time" : 1665221214
}

SDK Sample Code

The SDK sample code is as follows.

Java

Update an alert rule whose name is Alert rule, query type is SQL, status is Enabled, and Severity is Warning.

 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
72
73
74
75
76
77
78
79
80
81
82
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;
import java.util.Map;
import java.util.HashMap;

public class UpdateAlertRuleSolution {

    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();
        UpdateAlertRuleRequest request = new UpdateAlertRuleRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withRuleId("{rule_id}");
        UpdateAlertRuleRequestBody body = new UpdateAlertRuleRequestBody();
        List<AlertRuleTrigger> listbodyTriggers = new ArrayList<>();
        listbodyTriggers.add(
            new AlertRuleTrigger()
                .withMode(AlertRuleTrigger.ModeEnum.fromValue("COUNT"))
                .withOperator(AlertRuleTrigger.OperatorEnum.fromValue("GT"))
                .withExpression("10")
                .withSeverity(AlertRuleTrigger.SeverityEnum.fromValue("TIPS"))
        );
        Schedule schedulebody = new Schedule();
        schedulebody.withFrequencyInterval(5)
            .withFrequencyUnit(Schedule.FrequencyUnitEnum.fromValue("MINUTE"))
            .withPeriodInterval(5)
            .withPeriodUnit(Schedule.PeriodUnitEnum.fromValue("MINUTE"))
            .withDelayInterval(2)
            .withOvertimeInterval(10);
        Map<String, String> listbodyCustomProperties = new HashMap<>();
        listbodyCustomProperties.put("maintainer", "isap");
        listbodyCustomProperties.put("references", "https://localhost/references");
        body.withTriggers(listbodyTriggers);
        body.withSchedule(schedulebody);
        body.withEventGrouping(true);
        body.withCustomProperties(listbodyCustomProperties);
        body.withSeverity(UpdateAlertRuleRequestBody.SeverityEnum.fromValue("TIPS"));
        body.withStatus(UpdateAlertRuleRequestBody.StatusEnum.fromValue("ENABLED"));
        body.withQueryType(UpdateAlertRuleRequestBody.QueryTypeEnum.fromValue("SQL"));
        body.withQuery("* | select status, count(*) as count group by status");
        body.withRuleName("Alert rule");
        request.withBody(body);
        try {
            UpdateAlertRuleResponse response = client.updateAlertRule(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

Update an alert rule whose name is Alert rule, query type is SQL, status is Enabled, and Severity is Warning.

 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
# 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 = UpdateAlertRuleRequest()
        request.workspace_id = "{workspace_id}"
        request.rule_id = "{rule_id}"
        listTriggersbody = [
            AlertRuleTrigger(
                mode="COUNT",
                operator="GT",
                expression="10",
                severity="TIPS"
            )
        ]
        schedulebody = Schedule(
            frequency_interval=5,
            frequency_unit="MINUTE",
            period_interval=5,
            period_unit="MINUTE",
            delay_interval=2,
            overtime_interval=10
        )
        listCustomPropertiesbody = {
            "maintainer": "isap",
            "references": "https://localhost/references"
        }
        request.body = UpdateAlertRuleRequestBody(
            triggers=listTriggersbody,
            schedule=schedulebody,
            event_grouping=True,
            custom_properties=listCustomPropertiesbody,
            severity="TIPS",
            status="ENABLED",
            query_type="SQL",
            query="* | select status, count(*) as count group by status",
            rule_name="Alert rule"
        )
        response = client.update_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)

Go

Update an alert rule whose name is Alert rule, query type is SQL, status is Enabled, and Severity is Warning.

 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
72
73
74
75
76
77
78
79
80
81
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.UpdateAlertRuleRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.RuleId = "{rule_id}"
	modeTriggers:= model.GetAlertRuleTriggerModeEnum().COUNT
	operatorTriggers:= model.GetAlertRuleTriggerOperatorEnum().GT
	severityTriggers:= model.GetAlertRuleTriggerSeverityEnum().TIPS
	var listTriggersbody = []model.AlertRuleTrigger{
        {
            Mode: &modeTriggers,
            Operator: &operatorTriggers,
            Expression: "10",
            Severity: &severityTriggers,
        },
    }
	delayIntervalSchedule:= int32(2)
	overtimeIntervalSchedule:= int32(10)
	schedulebody := &model.Schedule{
		FrequencyInterval: int32(5),
		FrequencyUnit: model.GetScheduleFrequencyUnitEnum().MINUTE,
		PeriodInterval: int32(5),
		PeriodUnit: model.GetSchedulePeriodUnitEnum().MINUTE,
		DelayInterval: &delayIntervalSchedule,
		OvertimeInterval: &overtimeIntervalSchedule,
	}
	var listCustomPropertiesbody = map[string]string{
        "maintainer": "isap",
        "references": "https://localhost/references",
    }
	eventGroupingUpdateAlertRuleRequestBody:= true
	severityUpdateAlertRuleRequestBody:= model.GetUpdateAlertRuleRequestBodySeverityEnum().TIPS
	statusUpdateAlertRuleRequestBody:= model.GetUpdateAlertRuleRequestBodyStatusEnum().ENABLED
	queryTypeUpdateAlertRuleRequestBody:= model.GetUpdateAlertRuleRequestBodyQueryTypeEnum().SQL
	queryUpdateAlertRuleRequestBody:= "* | select status, count(*) as count group by status"
	ruleNameUpdateAlertRuleRequestBody:= "Alert rule"
	request.Body = &model.UpdateAlertRuleRequestBody{
		Triggers: &listTriggersbody,
		Schedule: schedulebody,
		EventGrouping: &eventGroupingUpdateAlertRuleRequestBody,
		CustomProperties: listCustomPropertiesbody,
		Severity: &severityUpdateAlertRuleRequestBody,
		Status: &statusUpdateAlertRuleRequestBody,
		QueryType: &queryTypeUpdateAlertRuleRequestBody,
		Query: &queryUpdateAlertRuleRequestBody,
		RuleName: &ruleNameUpdateAlertRuleRequestBody,
	}
	response, err := client.UpdateAlertRule(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

Request succeeded.

400

Request failed.

Error Codes

See Error Codes.