Obtaining the Silence Rule List

Updated on 2025-01-07 GMT+08:00

View PDF

Function

This API is used to obtain the silence rule list.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID obtained from IAM. Generally, a project ID contains 32 characters. Minimum: 32 Maximum: 32

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. Minimum: 1 Maximum: 40960
Content-Type	Yes	String	Content type, which is application/json. Enumeration values: application/json

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of MuteRule objects	OK: The request is successful.

**Table 4** MuteRule
Parameter	Type	Description
create_time	Long	Creation time. Minimum: 0 Maximum: 9999999999999
desc	String	Rule description. Minimum: 0 Maximum: 1024
match	Array<Array<Match>>	Match condition of the rule. Up to 10 serial or parallel conditions can be created. Array Length: 1 - 10
mute_config	MuteConfig object	Time when the rule takes effect.
name	String	Rule name. Enter a maximum of 100 characters and do not start or end with an underscore (_). Only letters, digits, and underscores are allowed. Minimum: 1 Maximum: 100
timezone	String	Time zone. Minimum: 1 Maximum: 32
update_time	Long	Modification time. Minimum: 0 Maximum: 9999999999999
user_id	String	User ID. Minimum: 32 Maximum: 32

**Table 5** Match
Parameter	Type	Description
key	String	Key specified in the metadata for matching. Minimum: 1 Maximum: 128
operate	String	Match mode. EXIST: Exist. REGEX: Regular expression. EQUALS: Equal to. Minimum: 1 Maximum: 100 Enumeration values: EQUALS REGEX EXIST
value	Array of strings	Value corresponding to the key. If operate is set to EXIST, this parameter is left empty. Minimum: 1 Maximum: 256 Array Length: 0 - 5

**Table 6** MuteConfig
Parameter	Type	Description
ends_at	Long	End time of the silence rule. Minimum: 0 Maximum: 999999999
scope	Array of integers	When type is set to WEEKLY or MONTHLY, scope cannot be empty. Minimum: 0 Maximum: 31 Array Length: 1 - 100
starts_at	Long	Start time of the silence rule. Minimum: 0 Maximum: 999999999
type	String	Type of the time for the silence rule to take effect. FIXED: Fixed time. DAILY: Certain time every day. WEEKLY: Certain time every week. MONTHLY: Certain time every month. Minimum: 1 Maximum: 100 Enumeration values: FIXED DAILY WEEKLY MONTHLY

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 12 Maximum: 12
error_msg	String	Error message. Minimum: 0 Maximum: 1024
error_type	String	Error type. Minimum: 0 Maximum: 128
trace_id	String	Request ID. Minimum: 32 Maximum: 32

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 12 Maximum: 12
error_msg	String	Error message. Minimum: 0 Maximum: 1024
error_type	String	Error type. Minimum: 0 Maximum: 128
trace_id	String	Request ID. Minimum: 32 Maximum: 32

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Response code. Minimum: 13 Maximum: 13
error_msg	String	Response message. Minimum: 1 Maximum: 100
trace_id	String	Response ID. Minimum: 12 Maximum: 12

Example Requests

Obtain the silence rule list.

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

Example Responses

Status code: 200

OK: The request is successful.

[ {
  "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" : "2a473356cca5487f8373be891bffc1cf"
} ]

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" : ""
}

Status Codes

Status Code	Description
200	OK: The request is successful.
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.