告警规则下发

1. 请求消息

1.1 topic

Topic
/v1/devices/{DeviceSn}/security/set

消息发送方

物联网平台

消息接收方

网关设备

1.2 请求消息payload

数据域
数据类型
是否必选
描述

mid

stirng

消息ID,推荐使用uuid, 请求和应答匹配,用来匹配请求和应答消息和去重

msgTime

string

消息发送时间戳,RFC3339标准,例如:1985-04-12T23:20:50.52Z

zone

string

设备部署的区域,例如ZONE3

node

string

设备部署的节点,例如440000

requestId

string

微服务链路追踪用的标识

deviceSn

string

设备ESN码,用于唯一标识设备

deviceId

string

统一物联网平台分配的设备id,据说可能会重复,不能唯一标识设备

service

string

服务名称。这里固定为:alarmManageService

cmd

string

具体操作方法,这里固定为:setAlarmThresholdConfig

params

List<Params>

是个list,每一项可以是个独立的规则

params结构体说明

字段名
必选/可选
类型
参数描述

ruleId

必选

String

规则id,每条规则需要有个id,便于后边更新或者删除

action

必选

String

ADD 、 DEL

indicator

必选

string

指标类型。具体指标包括:cpuTemp、cpuUsage、memUsage、diskUsage

severity

必选

string

告警级别,取值如下:Critical紧急、Major重要、Minor次要、Warning提示

threshold

必选

number

阈值

operator

可选

String

判断操作符EQ("="), NE("<>"), GT(">"), GE(">="), LT("<"), LE("<="),

unit

可选

String

单位

duration

可选

Uint16

统计周期

count

可选

uint16

统计次数,在统计周期内达到统计次数的时候将触发告警

请求示例

{
    "mid": "54132",
    "service": "alarmManageService",
    "cmd": "setAlarmThresholdConfig",
    "params": [{
        "ruleId": "111",
        "action": "ADD",
        "indicator": "cpuTemp",
        "severity": "Major",
        "threshold": 60.0,
        "operator": "GE",
        "unit": "°C",
    }],
    "zone":"设备部署的区域",
    "node":"设备部署的节点",
    "deviceSn": "D23pigXo",
    "deviceId": "A1234456",
    "requestId":"xxxxxxxxxx",
    "msgTime": "1985-04-12T23:20:50.52Z "
}

2. 应答消息(非必需)

2.1 Topic

Topic
/v1/devices/security/response

消息发送方

网关设备

消息接收方

物联网平台

2.2  应答消息payload

数据域
数据类型
是否必选
描述

mid

string

消息ID,用于消息去重。

replyId

string

表示响应的是哪条请求指令,为该指令的mid,用来匹配请求和应答

msgTime

string

消息发送时间戳,采用RFC3339标准,例如:1985-04-12T23:20:50.52Z。

zone

string

设备部署的区域,例如ZONE3

node

string

设备部署的节点,例如440000

requestId

string

微服务链路追踪用的标识

deviceSn

string

设备ESN码,用于唯一标识设备

deviceId

string

统一物联网平台分配的设备id,据说可能会重复,不能唯一标识设备

code

uint16

标识应答的返回码

批处理请求时,如果所有处理都成功,返回200

如果有部分失败,返回400。

取值如下:

•200:请求成功。

•400:请求消息错误,例如消息格式错误等。

•404:不支持该操作。

•429:请求太多。

•500:服务端内部错误,由应用定义。

body

JsonObject

(可选)对象内容。

应答示例

{
    "mid": "54132",
    "replyId": "54132"
    "code": 200,
    "zone":"设备部署的区域",
    "node":"设备部署的节点",
    "deviceSn": "D23pigXo",
    "deviceId": "A1234456",
    "requestId":"xxxxxxxxxx",
    "msgTime": "1985-04-12T23:20:50.52Z "
}

最后更新于