消费告警数据代码字段说明¶
可参考以下字段说明，在订阅告警数据后，编写消费告警数据的代码。
如需消费由告警引擎 2.2.0，2.3.0 及 2.4.0 版本产生的数据，请参考 新版本。
消费基础版本的告警数据时，需使用 HistoryEvent 结构体。
消费高级版本的告警数据时，需使用 AlertVo 结构体。
如需消费由告警引擎 2.1.0 版本产生的数据，请参考 旧版本 使用 HistoryEvent 结构体。
新版本¶
HistoryEvent 结构体字段
字段名称 |
数据类型 |
说明 |
|---|---|---|
eventId |
String |
告警 ID |
orgId |
String |
资产所属的组织 ID |
assetId |
String |
资产 ID |
modelId |
String |
资产所属模型 ID |
modelIdPath |
String |
模型所属路径 |
measurepointId |
String |
资产测点 |
deviceStatus |
String |
设备状态 |
hitRuleId |
Integer |
触发的告警规则的编号 |
value |
Object |
测点值。若告警规则中指定了 triggeringDelayTimer，则测点值为 triggeringDelayTimer 开始计时时测点的值 |
occurTime |
Long |
告警发生的时间。样例：1555468200000 |
localOccurTime |
String |
告警发生的时间，以本地时间表示。样例：2020-12-12 00:00:00 |
severityId |
Integer |
告警级别标识符 |
severityDesc |
StringI18n |
告警级别描述 |
typeId |
Integer |
告警类别标识符 |
typeDesc |
StringI18n |
告警类型的具体描述 |
subTypeId |
Integer |
告警子类型 |
subTypeDesc |
StringI18n |
告警子类型描述 |
contentId |
Integer |
告警内容标识符 |
contentDesc |
StringI18n |
告警内容描述 |
eventType |
Integer |
0：告警恢复事件, 其他值：普通事件 1：告警事件 2：接口产生的恢复事件 3：接口产生的告警事件 |
tag |
Map<String, String> |
规则上的标签 |
ruleDesc |
StringI18n |
规则描述 |
assetPath |
List<String> |
产生该告警的资产所处的树路径列表。返回格式为：[“treeId1:/assetId1/assetId2/assetIdx”, “treeId2:/assetId3/assetIdx”] |
maskedBy |
List<String> |
屏蔽该告警的告警。如果该告警条目是衍生告警，返回导致该告警被屏蔽的根源告警信息。返回格式为：[“treeId1:eventId1”, “treeId1:eventId2”] |
createTime |
Long |
该告警记录的入库时间，以 UTC 时间表示。样例：1555468200000 |
updateTime |
Long |
该告警记录的更新时间，以 UTC 时间表示。样例：1555468200000 |
recoverTime |
Long |
触发告警的异常状况恢复正常的时间，以 UTC 时间表示。样例：1555468200000 |
recoverLocalTime |
String |
触发告警的异常状况恢复正常的时间，以本地时间表示。样例：2020-12-12 00:00:00 |
recoverReason |
String |
异常状况恢复的原因 |
AlertVo 结构体字段
字段名称 |
数据类型 |
说明 |
|---|---|---|
alertId |
String |
告警 ID |
eventType |
Integer |
0：告警解除，通过规则触发（历史告警） 1：告警开始，通过规则触发（当前告警） 2：告警解除，通过接口创建（历史告警） 3：告警开始，通过接口创建（当前告警） 4：离散告警（历史告警） 5：乱序告警（dataSource 告警） 其中，在 Create Alert 接口中，只允许填 2、3、4 |
dataSource |
String |
告警数据源，例如 model_measurepoint 表示测点，device_status 表示设备状态，model_event 表示事件 |
orgId |
String |
资产所属的组织 ID |
instanceId |
String |
告警的实体，现阶段只有 asset，取值为 assetId |
metricId |
String |
原始度量数据的 ID |
occurTime |
Long |
告警发生的时间，以 UTC 时间表示。样例：1555468200000 |
localOccurTime |
String |
告警发生的时间，以本地时间表示。样例：2020-12-12 00:00:00 |
recoverTime |
Long |
触发告警的异常状况恢复正常的时间，以 UTC 时间表示。样例：1555468200000 |
localRecoverTime |
String |
触发告警的异常状况恢复正常的时间，以本地时间表示。样例：2020-12-12 00:00:00 |
recoverReason |
String |
异常状况恢复的原因 |
value |
String |
告警产生时的 metric value，对于高级的告警功能比如多测点告警或者时序告警，使用产生告警对应的那个 metric 的 value |
metricTags |
Map<String, String> |
原始度量数据的标签。Key 和 Value 为 String 不同业务/系统会有不同的原始度量，定义的标签也会不同。EnOS 有以下可能出现在 metricTags 标准标签。其中带有 __ 前缀和后缀的标签是通用的 key，没带 __ 的是与业务相关的 key { __timezone__: 时区 __instance__： instanceId __metric__： metricId __alias__： metricId 的别名 modelIdPath： 模型路径 modelId： modelId assetTreePath： 资产树路径 assetTreePath_${treeId}: 指定 treeId 的资产树路径 } |
severityId |
String |
告警级别编号 |
severityDesc |
StringI18n |
告警级别描述。结构参见下述子对象国际化名称结构体 |
typeId |
String |
告警类型编号 |
typeDesc |
StringI18n |
告警类型描述。结构参见下述子对象国际化名称结构体 |
parentTypeId |
String |
告警父类型编号 |
parentTypeDesc |
StringI18n |
告警父类型描述。结构参见下述子对象国际化名称结构体 |
contentId |
String |
告警内容 Id （仅基础告警包含） |
content |
StringI18n |
告警内容。结构参见子对象中的结构体 |
ruleId |
String |
告警规则编号 |
ruleDesc |
StringI18n |
告警规则描述。结构参见下述子对象国际化名称结构体 |
ruleTags |
Map（Key 为 String，Value 为 String） |
规则上的标签 |
tags |
Map（Key 为 String，Value 为 String） |
标签，只支持全量更新 |
isInhibited |
Boolean |
true：屏蔽 false：没被屏蔽 |
maskedBy |
List<String> |
根源告警 id（告警屏蔽时被哪些告警屏蔽） |
createTime |
Long |
告警创建时间 |
updateTime |
Long |
告警更新时间 |
ability |
int |
0 代表 basic 1 代表 advance |
旧版本¶
HistoryEvent 结构体字段¶
字段名称 |
数据类型 |
说明 |
|---|---|---|
eventId |
String |
告警 ID |
orgId |
String |
资产所属的组织 ID |
deviceId |
String |
资产 ID |
modelId |
String |
资产所属模型 ID |
modelIdPath |
String |
模型所属路径 |
pointId |
String |
资产测点 |
deviceStatus |
String |
设备状态 |
hitRuleId |
Integer |
触发的告警规则的编号 |
value |
Object |
测点值。若告警规则中指定了 triggeringDelayTimer，则测点值为 triggeringDelayTimer 开始计时时测点的值 |
time |
Long |
告警发生的时间。样例：1555468200000 |
localTime |
Long |
告警发生的时间，以本地时间表示。样例：1555468200000 |
severityId |
Integer |
告警级别标识符 |
severityDesc |
StringI18n |
告警级别描述 |
typeId |
Integer |
告警类别标识符 |
typeDesc |
StringI18n |
告警类型的具体描述 |
subTypeId |
Integer |
告警子类型 |
subTypeDesc |
StringI18n |
告警子类型描述 |
contentId |
Integer |
告警内容标识符 |
contentDesc |
StringI18n |
告警内容描述 |
eventType |
Integer |
0：告警恢复事件, 其他值：普通事件 1：告警事件 2：接口产生的恢复事件 3：接口产生的告警事件 |
ruleTag |
Map（Key 为 String，Value 为 String） |
规则上的标签 |
ruleDesc |
StringI18n |
规则描述 |
assetPath |
List<String> |
产生该告警的资产所处的树路径列表。返回格式为：[“treeId1:/assetId1/assetId2/assetIdx”, “treeId2:/assetId3/assetIdx”] |
maskedBy |
List<String> |
屏蔽该告警的告警。如果该告警条目是衍生告警，返回导致该告警被屏蔽的根源告警信息。返回格式为：[“treeId1:eventId1”, “treeId1:eventId2”] |
createTime |
Long |
该告警记录的入库时间，以 UTC 时间表示。样例：1555468200000 |
updateTime |
Long |
该告警记录的更新时间，以 UTC 时间表示。样例：1555468200000 |
recoverTime |
Long |
触发告警的异常状况恢复正常的时间，以 UTC 时间表示。样例：1555468200000 |
recoverLocalTime |
Long |
触发告警的异常状况恢复正常的时间，以本地时间表示。样例：1555468200000 |
recoverReason |
String |
异常状况恢复的原因 |
子对象字段说明¶
国际化名称结构体¶
字段名称 |
数据类型 |
说明 |
|---|---|---|
defaultValue |
String |
缺省名称 |
i18nValue |
Map<String, String> |
各个 Locale 下的名称，key 为 locale，value 为各个 locale 下的名称。 |
defaultValue 指，当使用的 locale 未在 i18nValue 中指定时，应当采用的名称。locale 格式遵循 Unicode locale identifier，例如 “en_US”。有关更多信息，请参阅 https://www.unicode.org/reports/tr35/tr35-55/tr35.html#BCP_47_Language_Tag_Conversion。