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
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 |
alarm_id |
Yes |
String |
Alarm rule ID. Regex Pattern: ^al([0-9A-Za-z]){22}$ |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
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 |
Yes |
String |
Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None |
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. |
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_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: 200
Parameter |
Type |
Description |
---|---|---|
notification_enabled |
Boolean |
Whether to enable alarm notifications. |
alarm_notifications |
Array of Notification objects |
Action to be triggered by the alarm. |
ok_notifications |
Array of Notification objects |
Action to be triggered after an alarm is cleared. |
notification_begin_time |
String |
Time when the alarm notification was enabled. |
notification_end_time |
String |
Time when the alarm notification was disabled. |
Parameter |
Type |
Description |
---|---|---|
type |
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_list |
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. |
Status code: 400
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
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" }
Status Codes
Status Code |
Description |
---|---|
200 |
Alarm notification information modified. |
400 |
Parameter verification failed. |
500 |
Internal system error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot