有关 EnOS 告警引擎 API¶
告警引擎是为运行和维护团队提供告警引擎功能，通过定义、接收和处理组织资产的告警，及早发现异常情况并迅速做出反应，满足对资产的实时状态监控和故障分析等业务需求。
通过告警引擎 API，应用开发人员可以创建、删除、搜索和更新告警级别、告警类型及告警规则，管理并获取告警内容。同时支持历史告警记录的创建、查询与关闭，以及更新告警标签。关于告警引擎 API 的完整接口列表及功能说明，参见 API 列表。
前提条件¶
确保已获取服务账号，且服务账号拥有调用该 API 的权限。更多信息，参见 获取 API 调用权限。
API 列表
¶
你可以通过以下表格了解可以调用告警引擎服务 API 执行哪些操作，每项操作对应的 URL，以及是否适用于 EnOS Cloud 和 EnOS Edge。
告警级别¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建一条告警级别 |
/event-service/v2.1/alert-severities?action=create |
√ |
× |
|
删除告警级别 |
/event-service/v2.1/alert-severities?action=delete |
√ |
× |
|
分页查询告警级别 |
/event-service/v2.1/alert-severities?action=search |
√ |
√ |
|
更新告警级别 |
/event-service/v2.1/alert-severities?action=update |
√ |
× |
告警类型¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建一条告警类型 |
/event-service/v2.1/alert-types?action=create |
√ |
× |
|
删除告警类型 |
/event-service/v2.1/alert-types?action=delete |
√ |
× |
|
分页查询告警类型 |
/event-service/v2.1/alert-types?action=search |
√ |
√ |
|
更新告警类型 |
/event-service/v2.1/alert-types?action=update |
√ |
× |
告警内容¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建告警内容 |
/event-service/v2.1/alert-contents?action=create |
√ |
× |
|
删除告警内容 |
/event-service/v2.1/alert-contents?action=delete |
√ |
× |
|
根据组织 ID 和内容 ID 获取告警内容 |
/event-service/v2.1/alert-contents?action=get |
√ |
√ |
|
查询告警内容分页 |
/event-service/v2.1/alert-contents?action=search |
√ |
√ |
|
更新告警内容 |
/event-service/v2.1/alert-contents?action=update |
√ |
× |
告警规则¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建一条告警规则 |
/event-service/v2.1/alert-rules?action=create |
√ |
× |
|
删除指定编号的告警规则 |
/event-service/v2.1/alert-rules?action=delete |
√ |
× |
|
查询告警规则 |
/event-service/v2.1/alert-rules?action=search |
√ |
√ |
|
更新告警规则 |
/event-service/v2.1/alert-rules?action=update |
√ |
× |
告警记录¶
历史与当前告警记录¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建告警 |
/alert-service/v2.1/alerts?action=create |
√ |
√ |
|
批量创建告警 |
/alert-service/v2.1/alerts?action=batchCreate |
√ |
√ |
|
查询当前和历史告警 |
/alert-service/v2.1/alerts?action=search |
√ |
√ |
|
查询当前和历史告警，返回结果可随便跳页 |
/alert-service/v2.1/alerts?action=scroll |
√ |
√ |
|
关闭当前告警，并且入库到历史告警库中 |
/alert-service/v2.1/alerts?action=close |
√ |
√ |
告警标签¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
更新当前和历史告警的标签内容 |
/alert-service/v2.1/alerts?action=updateTags |
√ |
√ |
|
批量更新当前和历史告警库中指定告警的标签内容 |
/alert-service/v2.1/alerts?action=batchUpdateTags |
√ |
√ |
通用错误码¶
代码 |
错误信息 |
描述 |
|---|---|---|
400 |
Wrong arguments |
传入了错误的参数 |
601 |
Duplicate |
数据重复 |
602 |
Business restriction |
业务限制 |
500 |
Internal error |
服务内部异常 |
SDK 示例¶
你可以在 Github 上获取告警引擎的 SDK 示例：