Creating, Deleting, Copying, or Modifying a Notification Template
A notification template is a notification content format that you can select when configuring alarm notifications. You can select a system template or default template provided by Cloud Eye, or create a custom template to send alarm notifications to recipients in the desired format via SMS, email, HTTP/HTTPS, SMN, WeCom, DingTalk, Lark, or WeLink.
A system template is automatically generated by Cloud Eye and cannot be modified. If you do not choose a custom template, alarm notifications will be sent using the system template. The system template is not displayed in the notification template list. Some cloud services do not support fields such as the resource name, enterprise project, resource tag, private IP address, and public IP address in the notification template. If these fields are configured, no values will be displayed for them when alarm notifications are sent.
The default template is provided by Cloud Eye and cannot be modified or deleted.
In addition to the system template and default template, you can also customize one. You can configure the protocol, notification type, and notification content for a notification template as needed.
This section describes how to create, delete, copy, or modify a notification template.
- Notification templates are available only in some regions. This feature will be available in other regions later. For details, check the console.
- Carriers may block certain details like links, IP addresses, email addresses, or phone numbers in SMS messages due to traffic control. This can prevent customers from receiving SMS messages.
- Using a system template for SMS notifications might prevent recipients from receiving them. Try using a custom template instead.
- If you are using a custom template for SMS notifications, avoid including fields like IP address, alarm rule ID, and alarm record ID in the notification content.
Constraints
- There are values for node role and node type only when the cloud product is DDS.
- Some cloud services do not support the Resource Name, Enterprise Project, Resource Tags, Private IP Address, and Public IP Address fields in the notification template. If these fields are configured, no values will be displayed for them when alarm notifications are sent.
- There is a value for Private IPv6 Address only when the cloud product is Elastic Cloud Server or Bare Metal Server.
- There is a value for Backup resource ID, Backup resource name, and Backup resource type only when the cloud product is Cloud Backup and Recovery.
- The First Occurrence Time field in the alarm notification shows when the alarm was initially triggered. If the status of the first triggered alarm is Insufficient data, this alarm triggering time will also be recorded in the alarm notification. The Alarm Generated field in the alarm record shows when the alarm record was generated. If the status of the first triggered alarm is Insufficient data, no alarm record is generated.
Creating a Notification Template
- Log in to the Cloud Eye console.
- In the navigation pane, choose Alarm Management > Alarm Notifications.
- Click the Notification Templates tab, click Create, and configure parameters.
- Configure basic parameters for a notification template.
Table 1 Parameters for creating a notification template Parameter
Description
Example Value
Name
Name of the notification template. The system generates a random name, but you can change it. The value can contain 1 to 200 characters.
noticeTemplate-d9wa
Description
(Optional) Provides supplementary information about the notification template.
-
Protocol
Over which protocol alarm notifications will be sent. The value can be SMS, Email, HTTP/HTTPS, WeCom, DingTalk, Lark, WeLink, or SMN. You can select multiple protocols for one template. This parameter cannot be modified when you modify a notification template.
SMS
Notification Type
Notification type of the notification template. The value can be Metric or Event. You can select only one option. This parameter cannot be modified when you change or copy a notification template.
When you are configuring an alarm rule, the alarm type of the alarm rule determines the alarm type of notification templates. For example, if Alarm Type is set to Metric, you can select only metric notification templates. For more information about alarm types, see Alarm Rules.
Metric
- Configure alarm notifications.
Table 2 Parameters for notification settings Parameter
Description
Title
Title of the alarm notification. This parameter is mandatory when Protocol is set to Email. You can click Add Content to set the alarm notification title.
Metric notifications support the following titles: Alarm Severity, Resource Type, Resource Name/Resource ID, Metric/Event Name, Trigger alarm/restore normal, and Alarm Record ID.
Event notifications support the following titles: Alarm Severity, Metric/Event Name, Trigger alarm/restore normal, and Alarm Record ID.
Format
Data format of the alarm notification. This parameter is mandatory only when Protocol is set to HTTP/HTTPS. The value can be Text or JSON.
Content
You can click Add Content to set the notification content by selecting one or more parameters. The available options for this parameter depend on the chosen notification type. For details, see Table 3.
Preview
Click Send to Test and then select required contact groups or topic subscriptions. For details about how to create a contact group and topic, see Creating a Contact/Contact Group and Creating Alarm Notification Topics.
NOTE:Topic subscriptions: Only SMN topics in the CN North-Beijing4 region can be used. Create SMN topics in this region if needed.
Table 3 Notification content Notification Type
Supported Content
Metric
Alarm Severity, Alarm Policy, Occurred At, Current Data, Alarm Rule Name, Alarm Rule Description, Region, Resource Name, Resource ID, Enterprise Project, Resource Tags, Private IP Address, Public IP Address, Resource Type, Alarm Notification ID, Region ID, Last for, Node Role, Node Type, Alarm Record ID, Alarm Notification Type, Dimension Details, Job Owner, Alarm Severity Change, Addition Info, and Private IPv6 Address.
By default, Alarm Severity and Alarm Record ID are selected.
NOTE:Alarm Notification Type, Dimension Details, Job Owner, Addition Info, and Alarm Severity Change are available only in some regions. For details, check the console.
Event
Alarm Severity, Alarm Policy, Occurred At, Alarm Rule Name, Alarm Rule Description, Region, Resource Name, Resource ID, Enterprise Project, Resource Tags, Private IP Address, Public IP Address, Region ID, Alarm Notification ID, Backup resource ID, Backup resource name, Backup resource type, Summary, Members, Location Information, Alarm Notification Type, Event Occurred At, Peak Inbound Bandwidth, Peak Outbound Bandwidth, Resource Bound, Trigger Mode, Monitoring Scope, Impact, Solution, Elastic IP, Addition Info, and Private IPv6 Address.
By default, Alarm Severity and Alarm Record ID are selected.
NOTE:Alarm Notification Type, Event Occurred At, Peak Inbound Bandwidth, Peak Outbound Bandwidth, Resource Bound, Trigger Mode, Monitoring Scope, Impact, Solution, Addition Info, and Elastic IP are available only in some regions. For details, check the console.
- Configure basic parameters for a notification template.
- Click Create.
On the Notification Templates tab, you can view the new notification template. Its type is Custom.
Deleting a Notification Template
If a notification template no longer meets your requirements, you can delete it. Deleted notification templates cannot be recovered. Alarm rules associated with them will be associated with the default notification templates.
- Log in to the Cloud Eye console.
- In the navigation pane, choose Alarm Management > Alarm Notifications.
- Select the Notification Templates tab.
- To delete a single notification template, locate that template and click Delete in the Operation column.
- To delete notification templates in batches, select multiple templates and click Delete above the list. Figure 1 Deleting a notification template
- In the Delete This Notification Template dialog box, enter DELETE and click OK.
Copying a Notification Template
- Log in to the Cloud Eye console.
- In the navigation pane, choose Alarm Management > Alarm Notifications.
- Select the Notification Templates tab.
- Locate the notification template and click Copy in the Operation column.
- On the Create Notification Template page, set parameters based on Table 1 and Table 2.
- Click Create.
The new notification template is added to the Notification Templates tab. Its type is Custom.
Modifying a Notification Template
If services change or you need to replan a notification template, you can update it.
- Log in to the Cloud Eye console.
- In the navigation pane, choose Alarm Management > Alarm Notifications.
- Select the Notification Templates tab.
- Locate the notification template and click Modify in the Operation column.
- On the Modify Notification Template page, modify the parameters as needed. For details, see Table 2.
- Click Modify.
Helpful Links
- If the resource name is configured in the template but not displayed in the received alarm notification, rectify the fault by referring to Why Are Resource Names Not Displayed in Alarm Notifications?
- Creating an Alarm Rule (New Version)
- Creating, Modifying, or Deleting a Notification Policy
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