doc-exports/docs/ces/api-ref/ces_03_0028.html

Querying Details of an Alarm Rule

Function

This API is used to query details of an alarm rule based on its ID.

URI

GET /V1.0/{project_id}/alarms/{alarm_id}

• Parameter description

  Table 1 Parameter description

  Parameter	Mandatory	Description
  project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Minimum: 1 Maximum: 64 Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
  alarm_id	Yes	Specifies the alarm rule ID.

• Example

  GET https://{Cloud Eye endpoint}/V1.0/{project_id}/alarms/al1441967036681YkazZ0deN

Request

None

Response

• Response parameters

  Parameter	Type	Description
  metric_alarms	Array of objects	Specifies the list of alarm objects. For details, see Table 2.

  Table 2 metric_alarms data structure description

  Parameter	Type	Description
  alarm_name	String	Specifies the alarm rule name.
  alarm_description	String	Provides supplementary information about the alarm rule.
  metric	Object	Specifies the alarm metric. For details, see Table 3.
  condition	Object	Specifies the alarm triggering condition. For details, see Table 7.
  alarm_enabled	Boolean	Specifies whether to enable the alarm rule.
  alarm_level	Integer	Specifies the alarm severity, which can be 1, 2 (default), 3 or 4, indicating critical, major, minor, and informational, respectively.
  alarm_action_enabled	Boolean	Specifies whether to enable the action to be triggered by an alarm.
  alarm_actions	Array of objects	Specifies the action to be triggered by an alarm. For details, see Table 5.
  ok_actions	Array of objects	Specifies the action to be triggered after the alarm is cleared. For details, see Table 6.
  alarm_id	String	Specifies the alarm rule ID.
  update_time	Long	Specifies when the alarm status changed. The value is a UNIX timestamp, in milliseconds.
  alarm_state	String	Specifies the alarm status, which can be ok: The alarm status is normal. alarm: An alarm is generated. insufficient_data: The required data is insufficient.

  Table 3 metric data structure description

  Parameter	Type	Description
  namespace	String	Specifies the namespace of a service. For details, see Services Interconnected with Cloud Eye.
  dimensions	Array of objects	Specifies the list of metric dimensions. For details, see Table 4.
  metric_name	String	Specifies the metric ID. For example, if the monitoring metric of an ECS is CPU usage, metric_name is cpu_util. For details, see Services Interconnected with Cloud Eye.

  Table 4 dimensions data structure description

  Parameter	Type	Description
  name	String	Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.
  value	String	Specifies the dimension value, for example, an ECS ID. The value contains 1 to 256 characters.

  Table 5 alarm_actions data structure description

  Parameter	Type	Description
  type	String	Specifies the alarm notification type. notification: A notification will be sent. autoscaling: A scaling action will be triggered.
  notificationList	Array of strings	Specifies the list of objects to be notified of alarm status changes. NOTE: The IDs in the list are strings.

  Table 6 ok_actions data structure description

  Parameter	Type	Description
  type	String	Specifies the notification type when an alarm is triggered. notification: A notification will be sent. autoscaling: A scaling action will be triggered.
  notificationList	Array of strings	Specifies the list of objects to be notified of alarm status changes. NOTE: The IDs in the list are strings.

  Table 7 condition data structure description

  Parameter	Type	Description
  period	Integer	Specifies the interval (seconds) for checking whether the configured alarm rules are met.
  filter	String	Specifies the data aggregation method. The value can be: average: average value of metric data within an aggregation period. max: maximum value of metric data in an aggregation period. min: minimum value of metric data within an aggregation period. sum: sum of metric data within an aggregation period. variance: variance value of metric data within an aggregation period.
  comparison_operator	String	Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.
  value	Double	Specifies the alarm threshold. Range: 0 to Number. MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.
  unit	String	Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs. Minimum: 0 Maximum: 32
  count	Integer	Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5
  suppress_duration	Integer	Specifies the interval for triggering an alarm if the alarm persists. The value can be: 0: alarm triggered only once. 300: alarm triggered every 5 minutes. 600: alarm triggered every 10 minutes. 900: alarm triggered every 15 minutes. 1800: alarm triggered every 30 minutes. 3600: alarm triggered every 1 hour. 10800: alarm triggered every 3 hours. 21600: alarm triggered every 6 hours. 43200: alarm triggered every 12 hours. 86400: alarm triggered every day.

• Example response

  {
  "metric_alarms":
    [
     {
      "alarm_name":"alarm-ipwx",
      "alarm_description":"",
      "metric":
       {
        "namespace":"SYS.ELB",
        "dimensions":
        [
         {
          "name":"lb_instance_id",
          "value":"44d06d10-bce0-4237-86b9-7b4d1e7d5621"
         }
        ],
        "metric_name":"m8_out_Bps"
        },
      "condition":
       {
        "period":300,
        "filter":"sum",
        "comparison_operator":">=",
        "value":0,
        "unit":"",
        "count":1,
        "suppress_duration":1800
        },
      "alarm_enabled":true,
      "alarm_level": 2,
      "alarm_action_enabled":true,
      "alarm_actions":
       [
        {
         "type":"notification",
         "notificationList":["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
        }
       ],
      "ok_actions":
       [
        {
         "type":"notification",
         "notificationList":["urn:smn:region:68438a86d98e427e907e0097b7e35d48:sd"]
        }
       ],
      "alarm_id":"al1498096535573r8DNy7Gyk",
      "update_time":1498100100000,
      "alarm_state":"alarm"
     }
    ]
  }

Returned Values

• Normal

  200

• Abnormal

  Returned Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	The authentication information is not provided or is incorrect.
  403 Forbidden	Access to the requested page is forbidden.
  408 Request Timeout	The request timed out.
  429 Too Many Requests	Concurrent requests are excessive.
  500 Internal Server Error	Failed to complete the request because of an internal service error.
  503 Service Unavailable	The service is currently unavailable.

Error Codes

See Error Codes.

Parent topic: Alarm Rules