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-11-20 GMT+08:00

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.

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 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
one_click_alarm_id	Yes	String	Definition One-click monitoring ID for a service. Constraints N/A Range 1 to 64 characters 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 the value is true, other fields are mandatory. If the value is 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
notification_manner	No	String	Definition Notification method. Constraints N/A Range The value can be: NOTIFICATION_GROUP: notification groups TOPIC_SUBSCRIPTION: topic subscriptions NOTIFICATION_POLICY: notification policies Default Value N/A
notification_policy_ids	No	Array of strings	Definition Associated notification policy IDs. Constraints The number of notification policy IDs ranges from 0 to 20.

**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: 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" ]
}