4. 异常事件API

API列表

API调用

3.1: 发送信息至规则引擎

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/rule/event/fire

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "payload": {
        "data": {
            "deviceId": "123123",
            "deviceName": "测试设备名",
            "eventCode": "device_run_out_of_battery",
            "extraAttribute": {
                "imageUrl": "www.baidu.com",
                "video": "ssss"
            }
        }
    }
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

3.2: 新增异常事件

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/event/add

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "msgId":"123123",
    "eventName":"测试事件1",
    "ruleName":"测试规则1",
    "ruleCondition":"离线",
    "deviceName":"测试设备",
    "triggerTime":"2020-08-19 16:00:00",
    "eventDesc":"this is test message",
    "triggerResult":"aaa",
    "eventLevel":"告警"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

3.3: 事件列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/event/list

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "msgId": "123123",
    "pageSize": 10,
    "pageNo": 1,
    "searchKey": { //searchKey必填，里面的筛选条件可以不填
        "eventName": "aa",
        "ruleName": "bb",
        "startTriggerTime": "2020-08-12 12:00:00",//开始与结束时间成对出现
        "endTriggerTime": "2020-08-19 19:00:00",
        "deviceId": "f522c7ede739638b",
        "ruleCategoryPid": 666666
    }
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {
        "total": 19096,
        "pageNo": 1,
        "pageSize": 10,
        "resultList": [{
            "handleBy": "测试处理人",
            "lastTime": 156282,
            "eventSource": "device",
            "ruleTemplateId": 62,
            "triggerTime": 1610177340000,
            "deviceId": "f522c7ede739638b",
            "deviceName": "47B20304",
            "ruleCategoryPid": 52,
            "eventDesc": "47B20304触发了环境质量测试生成的事件",
            "isRemoved": 0,
            "eventName": "47B20304触发了环境质量测试",
            "ruleName": "环境质量测试",
            "triggerResult": "无后续动作",
            "id": 19542,
            "ruleId": 1190,
            "ruleLevelId": 47,
            "extraAttribute": {
                "imageUrl": "www.baidu.com"
            },
            "handleTime": 1610333622000,
            "ruleCondition": "#198706_le_442",
            "ruleLevelName": "重要",
            "ruleCategoryName": "分类名称",
            "ruleCategoryPName": "分类888",
            "deviceInfo": {
                "productId": "48ee89ee438057bd861f255dc29fdc48",
                "sourceSystem": "0",
                "deviceName": "47B20304",
                "mac": "4D444C584747B20304",
                "productName": "建大仁科TVOC",
                "createTime": "2020-12-16 10:16:10",
                "registerStatus": 1,
                "online": 0,
                "id": "f522c7ede739638b",
                "lastOnLineTime": "2021-01-09 15:40:00",
                "projectId": 610,
                "brand": "0",
                "syncStatus": 1,
                "categoryId": 51
            },
            "edgeEventId": "640c227a5c9e27d06aeeffbf09d22809",
            "ruleTemplateType": "abnormalReverse",
            "handleMemo": "测试处理意见",
            "projectId": "610",
            "ruleCategoryId": 121,
            "status": 1
        }]
    },
    "message": "success"
}

3.4: 更新异常事件处理状态

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/event/status/update

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "msgId": "1123123",
    "ids": [19542],
    "status": 1,
    "handleBy": "测试处理人",
    "handleMemo": "测试处理意见"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {

  }
}

3.5: 删除事件

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/event/delete

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "msgId": "1123123",
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {

  }
}

3.6: 异常事件上报至Kafka

描述

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "deviceId": "a1b2c3d4e5",
  "ruleId": 1123,
  "deviceStatus": "run"
}

3.7: 查看当天事件统计

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/event/queryEventStatistics

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
        "totalEvent": 0,
        "notHandleEvent": 0
  }
}