Updated on 2026-02-26 GMT+08:00

Adding a Silence Rule

Function

Alarm silence rules can mask alarm notifications in specified periods. This API is used to create silence rules.

Max.: 100 silence rules. If this number has been reached, delete unnecessary rules.

Once a silence rule is created, it takes effect immediately.

Orchestration only applies to the alarms triggered by Prometheus and log monitoring-related alarm rules.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    aom:muteRule:create

    Write

    -

    -

    -

    -

URI

POST /v2/{project_id}/alert/mute-rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details, see Obtaining a Token.

Constraints

N/A

Range

Min. characters: 1

Max. characters: 40,960

Default Value

N/A

Content-Type

Yes

String

Definition

Message body type (format). Its value is application/json.

Constraints

N/A

Range

Fixed value.

Default Value

application/json

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

create_time

No

Long

Definition

Time when the silence rule was created (UTC timestamp, in milliseconds). Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool.

Constraints

N/A

Range

N/A

Default Value

N/A

desc

No

String

Definition

Rule description.

Constraints

Max. characters: 1,024

Range

N/A

Default Value

N/A

match

No

Array<Array<Match>>

Definition

Match condition of the rule.

Constraints

A maximum of 10 parallel conditions can be configured, and each parallel condition can contain a maximum of 10 serial conditions. A maximum of 100 conditions can be configured.

mute_config

Yes

MuteConfig object

Definition

Time when the rule takes effect.

Constraints

N/A

name

Yes

String

Definition

Rule name.

Constraints

Enter a maximum of 100 characters, which cannot start or end with an underscore (_). Only letters, digits, and underscores are allowed.

Range

N/A

Default Value

N/A

timezone

No

String

Definition

Time zone.

Constraints

N/A

Range

N/A

Default Value

N/A

update_time

No

Long

Definition

Time when the silence rule was modified (UTC timestamp, in milliseconds). Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool.

Constraints

N/A

Range

N/A

Default Value

N/A

user_id

No

String

Definition

ID of the user who created the silence rule. The actual value is the same as the project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 Match

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Key specified in the metadata for matching.

Constraints

N/A

Range

Min. characters: 1

Max. characters: 128

Default Value

N/A

operate

Yes

String

Definition

Matching method of the alarm rule.

Constraints

N/A

Range

  • EXIST

  • REGEX

  • EQUALS

Default Value

N/A

value

Yes

Array of strings

Definition

Value of the key.

Constraints

N/A

Range

Min. characters of an element: 1

Max. characters of an element: 256

Default Value

N/A

Table 5 MuteConfig

Parameter

Mandatory

Type

Description

ends_at

No

Long

Definition

End time of the silence rule (UTC timestamp, in milliseconds). If the silence rule is permanent, set this parameter to 0. Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool.

Constraints

N/A

Range

N/A

Default Value

N/A

scope

No

Array of integers

Definition

Silence scope.

Constraints

When type is set to WEEKLY or MONTHLY, scope cannot be empty.

Range

Min. value of an element: 0

Max. value of an element: 31

Default Value

N/A

starts_at

Yes

Long

Definition

Start time of the silence rule (UTC timestamp, in milliseconds). Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool.

Constraints

N/A

Range

N/A

Default Value

N/A

type

Yes

String

Definition

Type of the time for the silence rule to take effect.

Constraints

N/A

Range

  • FIXED

  • DAILY

  • WEEKLY

  • MONTHLY

Default Value

N/A

Response Parameters

Status code: 204

No Content: The request is successful, but no content is returned.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

error_type

String

Definition

Error type.

Range

N/A

trace_id

String

Definition

Request ID.

Range

N/A

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

error_type

String

Definition

Error type.

Range

N/A

trace_id

String

Definition

Request ID.

Range

N/A

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

error_type

String

Definition

Error type.

Range

N/A

trace_id

String

Definition

Request ID.

Range

N/A

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

trace_id

String

Response ID.

Example Requests

Add a silence rule whose name is "32255" and user ID is "2xxxxxxxxxxxxxxxxxxxxxxxxxcf".

https://{Endpoint}/v2/{project_id}/alert/mute-rules

{
  "create_time" : 1668147671966,
  "desc" : "",
  "match" : [ [ {
    "key" : "event_severity",
    "operate" : "EQUALS",
    "value" : [ "Info" ]
  } ] ],
  "mute_config" : {
    "ends_at" : 86399,
    "scope" : [ ],
    "starts_at" : 0,
    "type" : "DAILY"
  },
  "name" : "32255",
  "timezone" : "xxx",
  "update_time" : 1668147671966,
  "user_id" : "2xxxxxxxxxxxxxxxxxxxxxxxxxcf"
}

Example Responses

Status code: 400

Bad Request: Invalid request. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.08011001",
  "error_msg" : "the muteName is exist",
  "error_type" : "PARAM_INVALID",
  "trace_id" : ""
}

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

{
  "error_code" : "AOM.0403",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED",
  "trace_id" : null
}

Status code: 403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.0403",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED",
  "trace_id" : null
}

Status code: 500

Internal Server Error: The server is able to receive the request but unable to understand the request.

{
  "error_code" : "APM.00000500",
  "error_msg" : "Internal Server Error",
  "trace_id" : ""
}

SDK Sample Code

The SDK sample code is as follows.

Java

Add a silence rule whose name is "32255" and user ID is "2xxxxxxxxxxxxxxxxxxxxxxxxxcf".

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

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

public class AddMuteRulesSolution {

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

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        AddMuteRulesRequest request = new AddMuteRulesRequest();
        MuteRule body = new MuteRule();
        MuteConfig muteConfigbody = new MuteConfig();
        muteConfigbody.withEndsAt(86399L)
            .withStartsAt(0L)
            .withType(MuteConfig.TypeEnum.fromValue("DAILY"));
        List<String> listMatchValue = new ArrayList<>();
        listMatchValue.add("Info");
        List<Match> listMatchMatch = new ArrayList<>();
        listMatchMatch.add(
            new Match()
                .withKey("event_severity")
                .withOperate(Match.OperateEnum.fromValue("EQUALS"))
                .withValue(listMatchValue)
        );
        List<List<Match>> listbodyMatch = new ArrayList<>();
        listbodyMatch.add(listMatchMatch);
        body.withUserId("2xxxxxxxxxxxxxxxxxxxxxxxxxcf");
        body.withUpdateTime(1668147671966L);
        body.withTimezone("xxx");
        body.withName("32255");
        body.withMuteConfig(muteConfigbody);
        body.withMatch(listbodyMatch);
        body.withDesc("");
        body.withCreateTime(1668147671966L);
        request.withBody(body);
        try {
            AddMuteRulesResponse response = client.addMuteRules(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

Add a silence rule whose name is "32255" and user ID is "2xxxxxxxxxxxxxxxxxxxxxxxxxcf".

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v2.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.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 = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AddMuteRulesRequest()
        muteConfigbody = MuteConfig(
            ends_at=86399,
            starts_at=0,
            type="DAILY"
        )
        listValueMatch = [
            "Info"
        ]
        listMatchMatch = [
            Match(
                key="event_severity",
                operate="EQUALS",
                value=listValueMatch
            )
        ]
        listMatchbody = [
            listMatchMatch
        ]
        request.body = MuteRule(
            user_id="2xxxxxxxxxxxxxxxxxxxxxxxxxcf",
            update_time=1668147671966,
            timezone="xxx",
            name="32255",
            mute_config=muteConfigbody,
            match=listMatchbody,
            desc="",
            create_time=1668147671966
        )
        response = client.add_mute_rules(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

Add a silence rule whose name is "32255" and user ID is "2xxxxxxxxxxxxxxxxxxxxxxxxxcf".

 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 main

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

    request := &model.AddMuteRulesRequest{}
	endsAtMuteConfig:= int64(86399)
	muteConfigbody := &model.MuteConfig{
		EndsAt: &endsAtMuteConfig,
		StartsAt: int64(0),
		Type: model.GetMuteConfigTypeEnum().DAILY,
	}
	var listValueMatch = []string{
        "Info",
    }
	var listMatchMatch = []model.Match{
        {
            Key: "event_severity",
            Operate: model.GetMatchOperateEnum().EQUALS,
            Value: &listValueMatch,
        },
    }
	var listMatchbody = [][](model.Match){
        listMatchMatch,
    }
	userIdMuteRule:= "2xxxxxxxxxxxxxxxxxxxxxxxxxcf"
	updateTimeMuteRule:= int64(1668147671966)
	timezoneMuteRule:= "xxx"
	descMuteRule:= ""
	createTimeMuteRule:= int64(1668147671966)
	request.Body = &model.MuteRule{
		UserId: &userIdMuteRule,
		UpdateTime: &updateTimeMuteRule,
		Timezone: &timezoneMuteRule,
		Name: "32255",
		MuteConfig: muteConfigbody,
		Match: listMatchbody,
		Desc: &descMuteRule,
		CreateTime: &createTimeMuteRule,
	}
	response, err := client.AddMuteRules(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

204

No Content: The request is successful, but no content is returned.

400

Bad Request: Invalid request. The client should not repeat the request without modifications.

401

Unauthorized: The authentication information is incorrect or invalid.

403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

500

Internal Server Error: The server is able to receive the request but unable to understand the request.

Error Codes

See Error Codes.