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

Updated on 2025-11-20 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.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters Default Value N/A
alarm_id	Yes	String	Definition Alarm rule ID. Constraints N/A Range The value starts with al and is followed by 22 characters of letters, digits, or a combination of both. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Constraints: None Value range: The value can contain 1 to 64 characters. Default value: The default type is application/json; charset=UTF-8.
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
notification_enabled	Yes	Boolean	Definition Whether to enable alarm notifications. Constraints If this parameter is set to true, other fields are mandatory. If it is set to false, other fields are optional. Range A boolean value, which can be: true: enable false: disable Default Value N/A
alarm_notifications	No	Array of Notification objects	Definition: Notification group or topic subscription for alarm notifications. Constraints: You can configure 0 to 10 notification groups or topic subscriptions.
ok_notifications	No	Array of Notification objects	Definition: Information about the notification group or topic subscription when the alarm is cleared. Constraints: You can configure 0 to 10 notification groups or topic subscriptions.
notification_begin_time	No	String	Definition Time when alarm notifications were enabled. Constraints N/A Range The value allows 1 to 64 characters and can only contain digits and colons (:). Default Value N/A
notification_end_time	No	String	Definition Time when alarm notifications were disabled. Constraints N/A Range The value allows 1 to 64 characters and can only contain digits and colons (:). Default Value N/A
effective_timezone	No	String	Definition Time zone, for example, GMT-08:00, GMT+08:00, or GMT+0:00. Constraints N/A Range 1 to 16 characters Default Value N/A

**Table 4** Notification
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Notification type. Constraints N/A Range The value can be: notification: SMN notifications contact: account contacts contactGroup: notification groups autoscaling: AS notifications. This value is used only for AS. groupwatch: deprecated ecsRecovery: deprecated iecAction: deprecated Default Value N/A
notification_list	Yes	Array of strings	Definition Recipients to be notified of the alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section "Querying Topics". Constraints If type is set to notification, the value of notification_list cannot be left blank. If type is set to autoscaling, the value of notification_list must be left blank. If notification_enabled is set to true, you must specify either alarm_notifications or ok_notifications. If both alarm_notifications and ok_notifications are specified, their notification_list values must be the same. A maximum of 20 recipients are allowed.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
notification_enabled	Boolean	Definition Whether to enable alarm notifications. Range A boolean value, which can be: true: enable false: disable
alarm_notifications	Array of NotificationResp objects	Definition: Notification group or topic subscription for alarm notifications.
ok_notifications	Array of NotificationResp objects	Definition: Information about the notification group or topic subscription when the alarm is cleared.
notification_begin_time	String	Definition Time when alarm notifications were enabled. Range The value allows 1 to 64 characters and can only contain digits and colons (:).
notification_end_time	String	Definition Time when alarm notifications were disabled. Range The value allows 1 to 64 characters and can only contain digits and colons (:).

**Table 6** NotificationResp
Parameter	Type	Description
type	String	Definition Notification type. Range The value can be: notification: SMN notifications contact: account contacts contactGroup: notification groups autoscaling: AS notifications. It is used only in AS and is not recommended. groupwatch: deprecated ecsRecovery: deprecated iecAction: deprecated
notification_list	Array of strings	Definition Recipients to be notified of the alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section "Querying Topics".

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Example Requests

Modifying alarm notification information in an alarm rule.

{
  "notification_enabled" : true,
  "alarm_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:cn-north-7:65c438cab60xxxxxxx:CES_notification_group_MGj4AJ03X" ]
  } ],
  "ok_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:cn-north-7:65c438cab60xxxxxxx:CES_notification_group_MGj4AJ03X" ]
  } ],
  "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"
}