About EnOS Alert Engine APIs¶

Through the alert management, 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 Engine Overview.

The APIs in the alert management 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 Alert Service APIs, and whether they can be used by EnOS Cloud and EnOS Edge.

Alert Severity¶

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Create Alert Severity	Create a new alert severity	/event-service/v2.1/alert-severities?action=create	√	×
Delete Alert Severity	Delete an alert severity	/event-service/v2.1/alert-severities?action=delete	√	×
Search Alert Severity	Search for alert severity based on the search criteria	/event-service/v2.1/alert-severities?action=search	√	√
Update Alert Severity	Update an alert severity	/event-service/v2.1/alert-severities?action=update	√	×

Alert Type¶

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Create Alert Type	Create a new alert type	/event-service/v2.1/alert-types?action=create	√	×
Delete Alert Type	Delete an alert type	/event-service/v2.1/alert-types?action=delete	√	×
Search Alert Type	Search for alert types based on the search criteria	/event-service/v2.1/alert-types?action=search	√	√
Update Alert Type	Update an alert type	/event-service/v2.1/alert-types?action=update	√	×

Alert Content¶

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Create Alert Content	Create a new alert content	/event-service/v2.1/alert-contents?action=create	√	×
Delete Alert Content	Delete an alert content	/event-service/v2.1/alert-contents?action=delete	√	×
Get Alert Content	Get an alert content based on `orgId` and `contentId`	/event-service/v2.1/alert-contents?action=get	√	√
Search Alert Content	Search for alert content based on the search criteria	/event-service/v2.1/alert-contents?action=search	√	√
Update Alert Content	Update an alert content	/event-service/v2.1/alert-contents?action=update	√	×

Alert Rule¶

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Create Alert Rule	Create an alert rule	/event-service/v2.1/alert-rules?action=create	√	×
Delete Alert Rule	Delete an alert rule	/event-service/v2.1/alert-rules?action=delete	√	×
Search Alert Rule	Search for alert rules based on the search criteria	/event-service/v2.1/alert-rules?action=search	√	√
Update Alert Rule	Update an alert rule	/event-service/v2.1/alert-rules?action=update	√	×

Alert Records¶

The APIs here can be used for both the old and new alert versions in the EnOS Management Console.

History & Active Alert Records¶

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Create Alert	Create an alert	/alert-service/v2.1/alerts?action=create	√	√
Batch Create Alert	Batch create alerts	/alert-service/v2.1/alerts?action=batchCreate	√	√
Search Alerts	Query active and historical alerts, where the pages of the returned results do not have to be in order	/alert-service/v2.1/alerts?action=search	√	√
Scroll Alerts	Query active and historical alerts	/alert-service/v2.1/alerts?action=scroll	√	√
Close Alert	Closes the active alert and stores as a history alert	/alert-service/v2.1/alerts?action=close	√	√

Alert Tags¶

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Update Alert Tags	Update history and active alert tags	/alert-service/v2.1/alerts?action=updateTags	√	√
Batch Update Alert Tags	Batch update the tags for the specified history and active alerts	/alert-service/v2.1/alerts?action=batchUpdateTags	√	√

API Editions¶

The following table lists the API services included in Alert Engine Enterprise and Lightweight editions.

Category	Enterprise	Lightweight
Alert Severity	√	√
Alert Type	√	√
Alert Content	√	√
Alert Rule	√	√
Alert Records	√	√

Common Error Codes¶

Code	Message	Description
400	Wrong arguments	Passed in incorrect parameters
601	Duplicate	Data duplication
602	Business restriction	Business restrictions
500	Internal error	Internal service exception