Alert Service Overview¶

Through the alert service, you can define the alert content, type, severity level, and trigger conditions for the assets in the organization, and receive asset alert reporting and processing to achieve real-time status monitoring and fault analysis of the assets. For details on alert management, see Alert Management Overview.

The APIs in the alert service are some of the APIs EnOS provides that cover the core business processes of the system. For more information on EnOS APIs and the different APIs that EnOS provides, see About EnOS API.

For more information on how to invoke EnOS APIs, see Get Started with EnOS API.

Refer to the table below for the list of APIs, and whether they can be used by EnOS Cloud and EnOS Edge.

Alert Severity¶

Name	Description	EnOS Cloud	EnOS Edge
Create Alert Severity	Create a new alert severity	√	×
Delete Alert Severity	Delete an alert severity	√	×
Search Alert Severity	Search for alert severity based on the search criteria	√	√
Update Alert Severity	Update an alert severity	√	×

Alert Type¶

Name	Description	EnOS Cloud	EnOS Edge
Create Alert Type	Create a new alert type	√	×
Delete Alert Type	Delete an alert type	√	×
Search Alert Type	Search for alert types based on the search criteria	√	√
Update Alert Type	Update an alert type	√	×

Alert Content¶

Name	Description	EnOS Cloud	EnOS Edge
Create Alert Content	Create a new alert content	√	×
Delete Alert Content	Delete an alert content	√	×
Get Alert Content	Get an alert content based on `orgId` and `contentId`	√	√
Search Alert Content	Search for alert content based on the search criteria	√	√
Update Alert Content	Update an alert content	√	×

Alert Rule¶

Name	Description	EnOS Cloud	EnOS Edge
Create Alert Rule	Create an alert rule	√	×
Delete Alert Rule	Delete an alert rule	√	×
Search Alert Rule	Search for alert rules based on the search criteria	√	×
Update Alert Rule	Update an alert rule	√	×

Alert Record¶

Active Alert Record¶

Name	Description	EnOS Cloud	EnOS Edge
Aggregate Active Alerts	Calculate the number of active alerts	√	√
Close Active Alert	Close an active alert	√	√
Create Active Alert	Create an active alert	√	√
Create Active Alerts in Batch	Batch create active alerts	√	×
Delete Active Alert	Delete an active alert	√	√
Search Active Alerts	Search for active alerts based on the search criteria	√	√

History Alert Record¶

Name	Description	EnOS Cloud	EnOS Edge
Create History Alert	Create a new history alert	√	√
Create History Alerts in Batch	Batch create history alerts	√	×
Search History Alerts	Search for the past 3 months’ historical alerts	√	√
Scroll History Alerts	Search for the past 3 months’ historical alerts, querying the next page according to the returned pageToken	√	×

Alert Tags¶

Name	Description	EnOS Cloud	EnOS Edge
Batch Update Active Alert Tags	Batch update the tags for the specified alerts	√	√
Update Active Alert Tags	Update the tags of an active alert	√	√
Update History Alert Tags	Update the tags of a history alert	√	√