Querying the Alarm Action Rule List

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

View PDF

Function

This API is used to query the alarm action rule list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/alert/action-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
action_rules	Array of ActionRule objects	Alarm action rule list. Array Length: 0 - 1000

**Table 4** ActionRule
Parameter	Type	Description
rule_name	String	Rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, and underscores (_) are allowed. Minimum: 1 Maximum: 100
project_id	String	Project ID. Minimum: 32 Maximum: 32
user_name	String	Member account name. Minimum: 1 Maximum: 100
desc	String	Rule description. Enter a maximum of 1024 characters and do not start or end with an underscore (_). Only digits, letters, underscores (_), asterisk (), and spaces are allowed. Minimum: 0 Maximum: 1024*
type	String	Action type. Default: Notification. Minimum: 1 Maximum: 1 Enumeration values: 1 2
notification_template	String	Message template. Minimum: 1 Maximum: 100
create_time	Long	Creation time. Minimum: 0 Maximum: 9999999999999
update_time	Long	Modification time Minimum: 0 Maximum: 9999999999999
time_zone	String	Time zone. Minimum: 1 Maximum: 100
smn_topics	Array of SmnTopics objects	SMN topic. The total number of topics cannot exceed 5. Array Length: 1 - 5

**Table 5** SmnTopics
Parameter	Type	Description
display_name	String	Topic display name, which will be the name of an email sender. Max.: 192 bytes. This parameter is left blank by default. Minimum: 1 Maximum: 64
name	String	Name of the topic. Enter 1 to 255 characters starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed. Minimum: 1 Maximum: 255
push_policy	Integer	SMN message push policy. Options: 0 and 1. Minimum: 0 Maximum: 1
status	Integer	Status of the topic subscriber. 0: The topic has been deleted or the subscription list of this topic is empty. 1: The subscription object is in the subscribed state. 2: The subscription object is in the unsubscribed or canceled state. Enumeration values: 0 1 2
topic_urn	String	Unique resource identifier of the topic. Minimum: 1 Maximum: 100

Status code: 401

**Table 6** 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 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: 500

**Table 8** 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

Query all alarm action rules.

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

Example Responses

Status code: 200

OK: The request is successful.

{
  "action_rules" : [ {
    "create_time" : 1665991889597,
    "desc" : "",
    "notification_template" : "aom.built-in.template.zh",
    "project_id" : "2xxxxxxxxxxxxxxxxxxxxxf",
    "rule_name" : "1112222",
    "smn_topics" : [ {
      "display_name" : "",
      "name" : "gcmtest",
      "push_policy" : 0,
      "status" : 0,
      "topic_urn" : "urn:smn:xxx:2xxxxxxxxxxxxxxxxxxxxxf:gcmtest"
    } ],
    "time_zone" : "xxx",
    "type" : "1",
    "update_time" : 1665991889597,
    "user_name" : "kxxxxxt"
  } ]
}

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.