Skip to main content

Version: 2.13.2304

Alarm Notification

Create Alarm Notification Template

When an alert policy is triggered, send notification content through specified channels.

  • A webhook for the notified party needs to be prepared in advance, or the "syslog" notification method needs to be selected.
  • Alarm notification templates created in the cluster menu cannot be referenced by alert policies in Workspaces.
  • Alarm notification templates created in Workspaces cannot be referenced by alert policies in the cluster.
  1. Log in to the API7 Enterprise dashboard.
  2. In the top navigation menu, click on Cluster Management .
  3. In the left menu bar, click on Cluster List .
  4. Click on the View button of the specific cluster.
  5. If the alert policy that needs to use this notification template is at the entire cluster (all APIs and data plane nodes in the cluster) level, click on Alert Management-Notification Template in the left menu bar and skip Steps 6-8.
  6. In the left menu bar, click on Workspaces .
  7. Click on View button of the specific workspace.
  8. In the left menu bar, click on Alarm then click on Alarm notification .
  9. Click on Create button.
  10. Fill in the form.
  11. Click on Submit button.
info

If an alert policy is not configured with a notification template, triggered records can only be viewed in the alert history, and timely notification cannot be obtained.

Configure Alarm Notification Template

Modify the properties of the alarm notification template.

  • After the configuration is successful, it will not take effect until the next alert check cycle. Ongoing alert tasks will not be interrupted.
  1. Log in to the API7 Enterprise dashboard.
  2. In the top navigation menu, click on Cluster Management .
  3. In the left menu bar, click on Cluster List .
  4. Click on the View button of the specific cluster.
  5. If the alert policy that needs to use this notification template is at the entire cluster (all APIs and data plane nodes in the cluster) level, click on Alarm then click on Alarm notification in the left menu bar and skip Steps 6-8.
  6. In the left menu bar, click on Workspaces .
  7. Click on View button of the specific workspace.
  8. In the left menu bar, click on Alarm then click on Alarm notification .
  9. Click on Create button.
  10. Click on Configure button of the corresponding alarm notification template.
  11. Edit the properties of the notification template.
  12. Click on Submit button.

Delete Alarm Notification Template

Permanently disable the alarm notification template and delete the records.

The notification template cannot be deleted if there is any alert policy that references it.

  1. Log in to the API7 Enterprise dashboard.
  2. In the top navigation menu, click on Cluster Management .
  3. In the left menu bar, click on Cluster List .
  4. Click on View button of the specific cluster.
  5. If the alert policy that needs to use this notification template is at the cluster level (all APIs within the cluster and the data plane nodes), click on Alarm then click on Alarm notification in the left menu bar and skip steps 6-8.
  6. In the left menu bar, click on Workspaces .
  7. Click on View button of the specific workspace.
  8. In the left menu bar, click on Alarm then click on Alarm notification .
  9. Click on Delete button of the corresponding notification template.
  10. Click on Confirm button.

API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation