Help Center/ Application Operations Management/ API Reference/ APIs/ Alarm/ Querying the Alarm Action Rule List
Updated on 2026-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Alarm Action Rule List

Function

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

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:actionRule:list

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/alert/action-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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

action_rules

Array of ActionRule objects

Alarm notification rule list.
Table 4 ActionRule

Parameter

Type

Description

rule_name

String

Alarm notification 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.

project_id

String

Project ID.

user_name

String

Member account name.

desc

String

Rule description. Enter a maximum of 1,024 characters and do not start or end with an underscore (). Only digits, letters, underscores (), asterisk (*), and spaces are allowed.

type

String

Rule type.

  • 1: Prometheus monitoring.

  • 3: Log monitoring.

notification_template

String

Message template.

create_time

Long

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

update_time

Long

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

time_zone

String

Time zone.

smn_topics

Array of SmnTopics objects

SMN topic. Max.: 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.

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.

push_policy

Integer

SMN message push policy. Options: 0 and 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.

topic_urn

String

Unique resource identifier of the topic.

Status code: 401

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: 403

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: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

error_msg

String

Response message.

trace_id

String

Response ID.

Example Requests

Query all alarm action rules.

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

Example Responses

Status code: 200

{
  "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

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

Status code: 403

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

Status code: 500

{
  "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.

Error Codes

See Error Codes.

Parent topic: Alarm