Querying the Event Alarm Rule List

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/event2alarm-rule

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: 0 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 Event2alarmRuleBody objects	OK: The request is successful.

Table 4 Event2alarmRuleBody
Parameter	Type	Description
user_id	String	Project ID. Minimum: 32 Maximum: 32
name	String	Rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, underscores (_), and hyphens (-) are allowed. Minimum: 1 Maximum: 100
description	String	Rule description. Enter a maximum of 1024 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, and special characters (_-<>=,.) are allowed. Minimum: 0 Maximum: 1024
create_time	Integer	Creation time. Minimum: 0 Maximum: 9999999999999
update_time	Integer	Update time. Minimum: 0 Maximum: 9999999999999
resource_provider	String	Event source. Minimum: 0 Maximum: 64
metadata	metadata object	Source data.
enable	Boolean	Whether to enable the rule.
trigger_policies	Array of trigger_policies objects	Trigger policy. Array Length: 0 - 1024
alarm_type	String	Alarm type. notification: direct alarm reporting. denoising: alarm noise reduction. Minimum: 0 Maximum: 32 Enumeration values: notification denoising
action_rule	String	Alarm action rule. Minimum: 0 Maximum: 128
inhibit_rule	String	Alarm suppression rule. Minimum: 0 Maximum: 128
route_group_rule	String	Alarm grouping rule. Minimum: 0 Maximum: 128
event_names	Array of strings	Event name.
migrated	Boolean	Whether to migrate to AOM 2.0.
topics	Array of SmnTopics objects	SMN information.

Table 5 metadata
Parameter	Type	Description
customField	Array of strings	Custom tag. Minimum: 0 Maximum: 1024 Array Length: 0 - 1024

Table 6 trigger_policies
Parameter	Type	Description
id	Integer	ID. Minimum: 0 Maximum: 128
name	String	Event name. Minimum: 0 Maximum: 128
trigger_type	String	Trigger type. accumulative: Accumulated trigger. immediately: Immediate trigger. Minimum: 0 Maximum: 128 Enumeration values: accumulative immediately
period	Integer	Trigger cycle. Minimum: 1 Maximum: 86400
operator	String	Comparison operator. Minimum: 0 Maximum: 8
count	Integer	Number of trigger times. Minimum: 1 Maximum: 100
level	String	Alarm severity. Minimum: 0 Maximum: 32

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

Table 9 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 10 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

Example Requests

Query the event alarm rule list.

https://{endpoint}/v2/{project_id}/event2alarm-rule

Example Responses

Status code: 200

OK: The request is successful.

[ {
  "action_rule" : "1",
  "alarm_type" : "notification",
  "create_time" : 1701442632968,
  "description" : "",
  "enable" : true,
  "event_names" : [ ],
  "inhibit_rule" : "",
  "metadata" : {
    "customField" : [ "xxx" ]
  },
  "migrated" : false,
  "name" : "1jB5h6GnbY",
  "resource_provider" : "AOM",
  "route_group_rule" : "",
  "topics" : [ ],
  "trigger_policies" : [ {
    "count" : 99,
    "id" : 0,
    "level" : "",
    "name" : "",
    "operator" : ">=",
    "period" : 300,
    "trigger_type" : "accumulative"
  } ],
  "update_time" : 0,
  "user_id" : "2a473356cca5487f8373be891bffc1cf"
} ]

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

{
  "error_code" : "SVCSTG.AMS.2000051",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED"
}

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

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

Error Codes

See Error Codes.

Parent topic: Alarm

Предыдущая статья

Alarm

Следующая статья

Adding an Event Alarm Rule

Была ли эта статья полезна?

Поддержка Юридические документы