# 设备报警数据配置查询

  • 接口描述

用户可通过本接口获取自己名下指定设备的报警数据配置信息。

  • 请求方法

GET

  • 请求路径
/v1/dev/alarm/config
  • 接口传参说明
参数 含义 数据类型 传参限制 是否必填
currPage 当前页数 字符串 1-3位正整型数
perPage 每页条数 字符串 10 / 50 / 100
snCode 设备SN码 字符串 纯数字字符串
  • 返回值示例

此处仅描述data中包含的数据,外部返回值的含义请参考统一返回值 (opens new window)

{
  "list": [
    {
      "groupName": "电子围栏报警测试", // 配置分组名
      "snCode": "20010009", // 设备SN码
      "configId": 912, // 报警配置ID
      "scanTime": 1, // 扫描时间
      "alarmText": "设备超出预设范围,请注意", // 报警内容
      "dataType": 1, // 数据类型 (0-位,1-字)
      "sendState": 1, // 是否已同步到设备 (1-是,0-否)
      "alarmName": "电子围栏报警", // 报警名
      "alarmLevel": 1 // 报警级别
    }
  ],
  "totalPage": 1,
  "totalSize": 1
}

# 设备实时报警数据查询

  • 接口描述

用户可通过本接口获取自己名下指定设备的实时报警数据。

  • 请求方法

GET

  • 请求路径
/v1/dev/alarm/data
  • 接口传参说明
参数 含义 数据类型 传参限制 是否必填
currPage 当前页数 字符串 1-3位正整型数
perPage 每页条数 字符串 10 / 50 / 100
snCode 设备SN码 字符串 纯数字字符串
  • 返回值示例

此处仅描述data中包含的数据,外部返回值的含义请参考统一返回值 (opens new window)

{
  "list": [
    {
      "alarmType": 1, // 故障类型
      "snCode": "100031", // 设备SN码
      "alarmNote": "当前值为3663,大于1000", // 故障描述
      "configId": null, // 报警配置ID
      "alarmTime": "1970-01-01 08:33:41",// 报警时间
      "alarmName": "alarm0001", // 报警名
      "confirmTime": null, // 故障确认时间
      "alarmLevel": 1, // 报警级别
      "alarmInfo": "LW0>1000" // 故障详细信息
    }
  ],
  "totalPage": 1,
  "totalSize": 1
}

# 设备历史报警数据查询

  • 接口描述

用户可通过本接口获取自己名下指定设备的历史报警数据。

  • 请求方法

GET

  • 请求路径
/v1/dev/alarm/history
  • 接口传参说明
参数 含义 数据类型 传参限制 是否必填
currPage 当前页数 字符串 1-3位正整型数
perPage 每页条数 字符串 10 / 50 / 100
snCode 设备SN码 字符串 纯数字字符串
startTime 起始时间 字符串 10位时间戳
endTime 结束时间 字符串 10位时间戳
  • 返回值示例

此处仅描述data中包含的数据,外部返回值的含义请参考统一返回值 (opens new window)

{
  "list": [
    {
      "alarmType": 2, //故障类型
      "snCode": "100031", // 设备SN码
      "alarmNote": "", // 故障描述
      "configId": null, // 报警配置ID
      "alarmTime": "2021-06-23 15:51:31", // 报警时间
      "alarmLevel": 1, // 报警等级
      "alarmName": "alarm0001", // 报警名称
      "alarmInfo": "" // 故障详细信息
    }
  ],
  "totalPage": 1,
  "totalSize": 1
}