Modifying a Silence Rule

Function

This API is used to modify a silence rule.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details, see Obtaining a Token.
Content-Type	Yes	String	Message body type or format. Content type, which is application/json. Enumeration values: application/json

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
create_time	No	Long	Creation time.
desc	No	String	Rule description.
match	Yes	Array<Array<Match>>	Match condition of the rule. Up to 10 serial or parallel conditions can be created.
mute_config	Yes	MuteConfig object	Time when the rule takes effect.
name	Yes	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.
timezone	No	String	Time zone.
update_time	No	Long	Modification time.
user_id	No	String	User ID.

**Table 4** Match
Parameter	Mandatory	Type	Description
key	Yes	String	Key specified in the metadata for matching.
operate	Yes	String	Match mode. EXIST: Exist. REGEX: Regular expression. EQUALS: Equal to. Enumeration values: EQUALS REGEX EXIST
value	No	Array of strings	Value corresponding to the key. If operate is set to EXIST, this parameter is left empty.

**Table 5** MuteConfig
Parameter	Mandatory	Type	Description
ends_at	No	Long	End time of the silence rule.
scope	No	Array of integers	When type is set to WEEKLY or MONTHLY, scope cannot be empty.
starts_at	Yes	Long	Start time of the silence rule.
type	Yes	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. Enumeration values: FIXED DAILY WEEKLY MONTHLY

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	Error code.
error_msg	String	Error message.
error_type	String	Error type.
trace_id	String	Request ID.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_type	String	Error type.
trace_id	String	Request ID.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_type	String	Error type.
trace_id	String	Request ID.

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

Modify a silence rule whose name is "32255", time zone is "xxx", 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: The request is invalid. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.08012003",
  "error_msg" : "request insertParma probably has error",
  "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" : ""
}

Status Codes

Status Code	Description
204	No Content: The request is successful, but no content is returned.
400	Bad Request: The request is invalid. 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.