Help Center/ Cloud Eye/ API Reference/ API v2/ Alarm Notifications/ Modifying Alarm Notification Information in an Alarm Rule

Updated on 2024-04-30 GMT+08:00

View PDF

Modifying Alarm Notification Information in an Alarm Rule

Function

This API is used to modify alarm notification information in an alarm rule.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v2/{project_id}/alarms/{alarm_id}/notifications

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the tenant ID. Minimum: 1 Maximum: 64
alarm_id	Yes	String	Specifies the alarm rule ID. Regex Pattern: ^al([0-9A-Za-z]){22}$

Request Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
notification_enabled	Yes	Boolean	Specifies whether to enable the alarm notification. If the value is true, other parameters are mandatory. If the value is false, other parameters are optional.
alarm_notifications	No	Array of Notification objects	Specifies the action to be triggered by an alarm.
ok_notifications	No	Array of Notification objects	Specifies the action to be triggered after an alarm is cleared.
notification_begin_time	No	String	Specifies the time when the alarm notification was enabled.
notification_end_time	No	String	Specifies the time when the alarm notification was disabled.

**Table 4** Notification
Parameter	Mandatory	Type	Description
type	Yes	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	Yes	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. Array Length: 0 - 20

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
notification_enabled	Boolean	Specifies whether to enable the alarm notification.
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 an alarm is cleared.
notification_begin_time	String	Specifies the time when the alarm notification was enabled.
notification_end_time	String	Specifies the time when the alarm notification was disabled.

**Table 6** 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. Array Length: 0 - 20

Status code: 400

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

Modifying Alarm Notification Information in an Alarm Rule

{
  "notification_enabled" : true,
  "alarm_notifications" : [ {
    "type" : "",
    "notification_list" : [ ]
  } ],
  "ok_notifications" : [ {
    "type" : "",
    "notification_list" : [ ]
  } ],
  "notification_begin_time" : "00:00",
  "notification_end_time" : "23:59"
}

Example Responses

Status code: 200

Alarm notification information modified.

{
  "notification_enabled" : true,
  "alarm_notifications" : [ {
    "type" : "",
    "notification_list" : [ ]
  } ],
  "ok_notifications" : [ {
    "type" : "",
    "notification_list" : [ ]
  } ],
  "notification_begin_time" : "00:00",
  "notification_end_time" : "23:59"
}