Help Center/ Cloud Eye/ API Reference/ API V2/ One-Click Monitoring/ Batch Modifying Alarm Notifications in Alarm Rules for One Service with One-Click Monitoring Enabled

Updated on 2025-08-27 GMT+08:00

Online Debugging

CLI Examples

View PDF

Batch Modifying Alarm Notifications in Alarm Rules for One Service with One-Click Monitoring Enabled

Function

This API is used to batch modify alarm notifications in alarm rules for one service that has one-click monitoring enabled.

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}/one-click-alarms/{one_click_alarm_id}/notifications

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant ID. Constraints: None Value range: Project ID, 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 by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters. Default value: None
one_click_alarm_id	Yes	String	One-click monitoring ID for a service.

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. Default value: 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	Whether to enable alarm notifications. If the value is true, other fields are mandatory. If the value is false, other fields are optional.
alarm_notifications	No	Array of Notification objects	Action to be triggered by the alarm.
ok_notifications	No	Array of Notification objects	Action to be triggered after an alarm is cleared.
notification_begin_time	No	String	Time when the alarm notification was enabled.
notification_end_time	No	String	Time when the alarm notification was disabled.
effective_timezone	No	String	Time zone, for example, GMT-08:00, GMT+08:00, or GMT+0:00.
notification_manner	No	String	Notification mode, which can be NOTIFICATION_GROUP (notification groups), TOPIC_SUBSCRIPTION (topic subscriptions), or NOTIFICATION_POLICY (notification policies). Enumeration values: NOTIFICATION_GROUP TOPIC_SUBSCRIPTION NOTIFICATION_POLICY
notification_policy_ids	No	Array of strings	Associated notification policy IDs.

**Table 4** Notification
Parameter	Mandatory	Type	Description
type	Yes	String	Notification type. The value can be notification (SMN notifications), contact (account contacts), contactGroup (notification groups), or autoscaling (AS notifications). autoscaling is used only in AS and is not recommended. groupwatch, ecsRecovery, and iecAction are no longer used. Enumeration values: notification autoscaling groupwatch ecsRecovery contact contactGroup iecAction
notification_list	Yes	Array of strings	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". If type is set to notification, the value of notificationList cannot be left blank. If type is set to autoscaling, the value of notification_list must be left blank. Note: If alarm_action_enabled is set to true, alarm_actions, ok_actions, or both of them must be specified. If both alarm_actions and ok_actions are specified, their notification_list values must be the same.

Response Parameters

Status code: 204

No Content

Status code: 400

**Table 5** 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: 401

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

**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: 404

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

Status code: 500

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

{
  "notification_enabled" : true,
  "alarm_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:123" ]
  } ],
  "ok_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:123" ]
  } ],
  "notification_begin_time" : "00:00",
  "notification_end_time" : "23:59",
  "notification_manner" : "NOTIFICATION_POLICY",
  "notification_policy_ids" : [ "np15563156337845e8A2Wv63" ]
}