有关 EnOS 告警引擎 API


通过告警引擎可以定义组织内资产的告警内容,类型,严重级别,及触发条件,并可接收资产告警上报和处理,以实现对资产的实时状态监控和故障分析等业务需求。有关告警引擎的详细信息,参见 告警引擎


告警引擎中的接口是一些 EnOS 开放涵盖系统各个核心业务流程的 Open API 接口。有关 EnOS API 和 EnOS 提供的接口详细信息,参见 有关 EnOS API


有关如何调用 EnOS API 的信息,参见 EnOS API 快速入门

告警级别

操作名称

描述

URL

适用于 EnOS Cloud

适用于 EnOS Edge

Create Alert Severity

创建一条告警级别

/event-service/v2.1/alert-severities?action=create

×

Delete Alert Severity

删除告警级别

/event-service/v2.1/alert-severities?action=delete

×

Search Alert Severity

分页查询告警级别

/event-service/v2.1/alert-severities?action=search

Update Alert Severity

更新告警级别

/event-service/v2.1/alert-severities?action=update

×

告警类型

操作名称

描述

URL

适用于 EnOS Cloud

适用于 EnOS Edge

Create Alert Type

创建一条告警类型

/event-service/v2.1/alert-types?action=create

×

Delete Alert Type

删除告警类型

/event-service/v2.1/alert-types?action=delete

×

Search Alert Type

分页查询告警类型

/event-service/v2.1/alert-types?action=search

Update Alert Type

更新告警类型

/event-service/v2.1/alert-types?action=update

×

告警内容

操作名称

描述

URL

适用于 EnOS Cloud

适用于 EnOS Edge

Create Alert Content

创建告警内容

/event-service/v2.1/alert-contents?action=create

×

Delete Alert Content

删除告警内容

/event-service/v2.1/alert-contents?action=delete

×

Get Alert Content

根据组织 ID 和内容 ID 获取告警内容

/event-service/v2.1/alert-contents?action=get

Search Alert Content

查询告警内容分页

/event-service/v2.1/alert-contents?action=search

Update Alert Content

更新告警内容

/event-service/v2.1/alert-contents?action=update

×

告警规则

操作名称

描述

URL

适用于 EnOS Cloud

适用于 EnOS Edge

Create Alert Rule

创建一条告警规则

/event-service/v2.1/alert-rules?action=create

×

Delete Alert Rule

删除指定编号的告警规则

/event-service/v2.1/alert-rules?action=delete

×

Search Alert Rule

查询告警规则

/event-service/v2.1/alert-rules?action=search

Update Alert Rule

更新告警规则

/event-service/v2.1/alert-rules?action=update

×

告警记录

告警记录的 API 适用于 EnOS 管理控制台中的历史和当前告警记录。

历史与当前告警记录

操作名称

描述

URL

适用于 EnOS Cloud

适用于 EnOS Edge

Create Alert

创建告警

/alert-service/v2.1/alerts?action=create

Batch Create Alerts

批量创建告警

/alert-service/v2.1/alerts?action=batchCreate

Search Alerts

查询当前和历史告警

/alert-service/v2.1/alerts?action=search

Scroll Alerts

查询当前和历史告警,返回结果可随便跳页

/alert-service/v2.1/alerts?action=scroll

Close Alert

关闭当前告警,并且入库到历史告警库中

/alert-service/v2.1/alerts?action=close

告警标签

操作名称

描述

URL

适用于 EnOS Cloud

适用于 EnOS Edge

Update Alert Tags

更新当前和历史告警的标签内容

/alert-service/v2.1/alerts?action=updateTags

Batch Update Alert Tags

批量更新当前和历史告警库中指定告警的标签内容

/alert-service/v2.1/alerts?action=batchUpdateTags

API 版本

下表列出告警引擎服务企业版与轻量版包含的 API 服务。

API 类别

企业版

轻量版

告警级别

告警类型

告警内容

告警规则

告警记录

通用错误码

代码

错误信息

描述

400

Wrong arguments

传入了错误的参数

601

Duplicate

数据重复

602

Business restriction

业务限制

500

Internal error

服务内部异常