Querying Alarm Rules

Function

This API is used to querying alarm rules.

URI

GET /v2/{project_id}/alarms

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the tenant ID. Minimum: 1 Maximum: 64 Regex Pattern: ^[a-zA-Z0-9-]{1,64}$

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
alarm_id	No	String	Specifies the alarm rule ID. Regex Pattern: ^al([0-9A-Za-z]){22}$
name	No	String	Specifies the name of an alarm rule. The name can contain 1 to 128 characters, including only letters, digits, underscores (_), and hyphens (-). Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
namespace	No	String	Specifies the namespace of a service. For details about the namespace of each service, see the Namespace column. Maximum: 32 Regex Pattern: ^((([a-z]\|[A-Z]){1}([a-z]\|[A-Z]\|[0-9]\|_)\.([a-z]\|[A-Z]){1}([a-z]\|[A-Z]\|[0-9]\|_))\|)$
resource_id	No	String	Specifies the alarm resource ID. If a resource has multiple dimensions, the resource IDs are sorted in ascending alphabetical order and separated by commas (,). Maximum: 700 Regex Pattern: ^([a-z]\|[A-Z]\|[0-9]\|_\|-\|:\|,\|\.\|)+$
enterprise_project_id	No	String	Specifies the enterprise project ID. Regex Pattern: ^((([a-z]\|[0-9]){8}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){4}-([a-z]\|[0-9]){12})\|0)$
offset	No	Integer	Specifies the pagination offset. Minimum: 0 Maximum: 10000 Default: 0 Regex Pattern: ^([0]\|[1-9]\|[1-9][0-9]\|[1-9][0-9][0-9]\|[1-9][0-9][0-9][0-9]\|10000)$
limit	No	Integer	Specifies the page size. Minimum: 1 Maximum: 100 Default: 10 Regex Pattern: ^([1-9]\|[1-9][0-9]\|100)$

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Specifies the MIME type of a request body. The default type is application/json; charset=UTF-8. Default: application/json; charset=UTF-8 Minimum: 1 Maximum: 64
X-Auth-Token	Yes	String	Specifies the user token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
alarms	Array of alarms objects	Specifies the alarm rule list.
count	Integer	Specifies total number of alarm rules. Minimum: 0 Maximum: 10000

**Table 5** alarms
Parameter	Type	Description
alarm_id	String	Specifies the alarm rule ID, which starts with al and is followed by a 22-digit string consisting of letters and digits.
name	String	Specifies the name of an alarm rule. The name can contain 1 to 128 characters, including only letters, digits, underscores (_), and hyphens (-).
description	String	Provides supplementary information about the alarm rule. The description can contain 0 to 256 characters.
namespace	String	Specifies the namespace of a service. For details about the namespace of each service, see the Namespace column.
policies	Array of Policy objects	Alarm Policies
resources	Array of ResourcesInListResp objects	Specifies the resource list. Associated resources can be obtained using the API for querying alarm rules.
type	String	Specifies the alarm rule type. Enumeration values: EVENT.SYS EVENT.CUSTOM DNSHealthCheck RESOURCE_GROUP MULTI_INSTANCE ALL_INSTANCE
enabled	Boolean	Specifies whether an alarm rule is enabled.
notification_enabled	Boolean	Specifies whether to enable alarm notifications.
alarm_notifications	Array of Notification objects	Specifies the action to be triggered by an alarm.
ok_notifications	Array of Notification objects	Specifies the action to be triggered after the alarm is cleared.
notification_begin_time	String	Specifies the time when alarm notifications are enabled.
notification_end_time	String	Specifies the time when alarm notifications are disabled.
enterprise_project_id	String	Specifies the enterprise project ID.
alarm_template_id	String	Specifies the ID of the alarm template associated with the alarm rule. If this parameter is specified, the policy associated with the alarm rule changes accordingly with the alarm template policy.

**Table 6** Policy
Parameter	Type	Description
metric_name	String	Specifies the metric name of a resource. The name must start with a letter and contain only letter, digits, and underscores (_) . The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service metric name.
period	Integer	Specifies the monitoring period of a metric, in seconds. The default value is 0. For example, for an event alarm, set this parameter to 0. 1 indicates the original monitoring period of the metric. For example, if the original period of an RDS metric is 60s, the RDS metric is calculated every 60 seconds as a data point. For details about the original period of each cloud service metric, see the Namespace column. 300 indicates that the metric is calculated every 5 minutes as a data point. Minimum: 0 Maximum: 86400 Enumeration values: 0 1 300 1200 3600 14400 86400
filter	String	Specifies the aggregation method. The value can be average, min, max, or sum.
comparison_operator	String	Specifies the threshold operator, which can be >, <, >=, <=, =, or ><.
value	Number	Specifies the threshold.
unit	String	Specifies the unit.
count	Integer	Specifies the number of counts that the threshold is met.
suppress_duration	Integer	Specifies the alarm suppression time, in seconds. This field corresponds to the last field of the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and an alarm is generated when the condition is met. 300 indicates that an alarm is generated every 5 minutes after the alarm triggering condition is met. Minimum: 0 Maximum: 86400 Enumeration values: 0 300 600 900 1800 3600 10800 21600 43200 86400
level	Integer	Specifies the alarm severity, which can be: 1 (critical), 2 (major), 3 (minor) or 4 (informational).

**Table 7** ResourcesInListResp
Parameter	Type	Description
resource_group_id	String	Specifies the resource group ID. This parameter is available when Monitoring Scope is set to Resource Groups. Regex Pattern: ^rg([a-z]\|[A-Z]\|[0-9]){22}$
resource_group_name	String	Specifies the resource group name. This parameter is available when Monitoring Scope is set to Resource Groups. Minimum: 1 Maximum: 128
dimensions	Array of MetricDimension objects	Specifies the dimension information.

**Table 8** MetricDimension
Parameter	Type	Description
name	String	Specifies the name of the metric dimension. Minimum: 1 Maximum: 32 Regex Pattern: ^([a-z]\|[A-Z]){1}([a-z]\|[A-Z]\|[0-9]\|_\|-){1,32}$
value	String	Specifies the value of the metric dimension. Minimum: 0 Maximum: 256 Regex Pattern: ^((([a-z]\|[A-Z]\|[0-9]){1}([a-z]\|[A-Z]\|[0-9]\|_\|-)*)\|){0,256}$

**Table 9** Notification
Parameter	Type	Description
type	String	Specifies the notification type. notification indicates that notifications are sent through Simple Message Notification (SMN). Regex Pattern: ^(notification\|autoscaling\|ecsRecovery\|contact\|contactGroup\|iecAction)$
notification_list	Array of strings	Specifies the list of objects to be notified if the alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section "Querying Topics". When type is set to notification, notification_list cannot be left blank. Note: If alarm_action_enabled is set to true, alarm_actions, ok_actions, or both of them must be specified. If alarm_actions and ok_actions coexist, their notification_list values must be the same.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Specifies the request error message. Minimum: 0 Maximum: 256
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 256

Example Requests

/v2/{project_id}/alarms?offset=0&limit=10

Example Responses

Status code: 200

Query succeeded.

{
  "alarms" : [ {
    "alarm_id" : "al16558829757444BVVxr999",
    "name" : "alarm01",
    "description" : "",
    "namespace" : "SYS.ECS",
    "policies" : [ {
      "metric_name" : "disk_device_read_bytes_rate",
      "period" : 1,
      "filter" : "average",
      "comparison_operator" : ">",
      "value" : 75,
      "unit" : "byte/s",
      "count" : 3,
      "suppress_duration" : 10800,
      "level" : 2
    } ],
    "resources" : [ {
      "dimensions" : [ {
        "name" : "disk_name"
      } ]
    } ],
    "type" : "ALL_INSTANCE",
    "enabled" : true,
    "notification_enabled" : true,
    "alarm_notifications" : [ {
      "type" : "notification",
      "notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ]
    } ],
    "ok_notifications" : [ {
      "type" : "notification",
      "notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ]
    } ],
    "notification_begin_time" : "00:00",
    "notification_end_time" : "23:59",
    "enterprise_project_id" : 0
  } ]
}