You need to enable JavaScript to run this app.
导航

报警列表查询

最近更新时间2022.08.12 13:53:07

首次发布时间2022.08.12 13:53:07

查询指定设备在指定时间段内的报警事件信息。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称ListAlarmNotify
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01

SpaceID

Query

String

空间 ID

可通过调用 ListSpaces 接口获取

Body参数

字段
类型
必填
说明
DeviceNSIDString设备国标 ID,可通过调用 ListDevices 接口获取
ChannelIDString通道 ID(如不指定,则查询所有通道的报警信息)

StartTime

Timestamp

查询起始时间,秒级时间戳,例如:1660031340

EndTime

Timestamp

查询结束时间,秒级时间戳,例如:1660041340

AlarmMethod

[]uint32

告警方式筛选条件,可选枚举值为(如传入空数组,即返回所有告警方式的报警记录):

  • 1(电话报警)
  • 2(设备报警)
  • 3(短信报警
  • 4(GPS报警)
  • 5(视频报警)
  • 6(设备故障报警)
  • 7(其他报警)

AlarmPriority

[]uint32

报警级别筛选条件,可选枚举值为(如传入空数组,即返回所有告警级别的报警记录):

  • 1(一级警情)
  • 2(二级警情)
  • 3(三级警情)
  • 4(四级警情)

AlarmType2

[]uint32

设备报警筛选条件,可选枚举值为(如传入空数组,即返回所有设备报警的报警记录):

  • 1(视频丢失报警)
  • 2(设备防拆报警)
  • 3(存储设备磁盘满报警)
  • 4(设备高温报警)
  • 5(设备低温报警)

AlarmType5

[]uint32

视频报警筛选条件,可选枚举值为(如传入空数组,即返回所有视频报警的报警记录):

  • 1(人工视频报警)
  • 2(运动目标检测报警)
  • 3(遗留物检测报警)
  • 4(物体移除检测报警)
  • 5(绊线检测报警)
  • 6(入侵检测报警)
  • 7(逆行检测报警)
  • 8(徘徊检测报警)
  • 9(流量统计报警)
  • 10(密度检测报警)
  • 11(视频异常检测报警)
  • 12(快速移动报警)

AlarmType6

[]uint32

设备故障报警筛选条件,可选枚举值为(如传入空数组,即返回所有设备故障报警的报警记录):

  • 1(存储设备磁盘故障报警)
  • 2(存储设备风扇故障报警)

Order

uint32

排序方式:

  • 0(正序)
  • 其他(倒序)

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
AlarmNotifiesArray of objects查询到的报警信息列表,参考以下 List<AlarmNotifies> 数据结构说明

List<AlarmNotifies> 数据结构说明

字段
类型
说明
AccountIDString火山引擎账户 ID
SpaceIDString空间 ID
DeviceNSIDString设备国标 ID
CmdTypeString固定为 Alarm
SNString序号
ChannelIDString通道 ID
AlarmNotifyIDString报警记录 ID

AlarmPriority

Int

报警级别:

  • 1(一级警情)
  • 2(二级警情)
  • 3(三级警情)
  • 4(四级警情)

AlarmMethod

Int

报警方式:

  • 1(电话报警)
  • 2(设备报警)
  • 3(短信报警
  • 4(GPS报警)
  • 5(视频报警)
  • 6(设备故障报警)
  • 7(其他报警)
AlarmTimeTimestamp报警时间
AlarmDescriptionString报警内容描述
LongitudeString设备经度
LatitudeString设备纬度
AlarmInfoString警情描述

Info

Array of objects

警情详细信息,参考以下 警情详细信息结构说明

警情详细信息结构说明

字段
类型
说明

AlarmType

Int

报警类型,详细说明如下:

  • 当 AlarmMethod=2(设备报警)时:
    • 1(视频丢失报警)
    • 2(设备防拆报警)
    • 3(存储设备磁盘满报警)
    • 4(设备高温报警)
    • 5(设备低温报警)
  • 当 AlarmMethod=5(视频报警)时:
    • 1(人工视频报警)
    • 2(运动目标检测报警)
    • 3(遗留物检测报警)
    • 4(物体移除检测报警)
    • 5(绊线检测报警)
    • 6(入侵检测报警)
    • 7(逆行检测报警)
    • 8(徘徊检测报警)
    • 9(流量统计报警)
    • 10(密度检测报警)
    • 11(视频异常检测报警)
    • 12(快速移动报警)
  • 当 AlarmMethod=6(设备故障报警)时:
    • 1(存储设备磁盘故障报警)
    • 2(存储设备风扇故障报警)

AlarmTypeParam.EventType

Int

事件类型:

  • 1(进入区域)
  • 2(离开区域)

示例

请求示例

POST https://open.volcengineapi.com?Action=ListAlarmNotify
&Version=2021-01-01
&SpaceID=c0f4bcda-35b6-4750-b900-ec97bexxxxxx
&<公共请求参数>
{
    "DeviceNSID": "34020044991320xxxxxx",
    "StartTime": 1660031340, 
    "EndTime": 1660048340, 
    "AlarmMethod": [5],
    "AlarmPriority": [],
    "AlarmType2": [],
    "AlarmType5": [],
    "AlarmType6": [],
    "Order": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202208101604070102251460630903BFAC",
        "Action": "ListAlarmNotify",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 2,
        "AlarmNotifies": [
            {
                "AccountID": "2100xxxxxx",
                "SpaceID": "c0f4bcda-35b6-4750-b900-ec97bexxxxxx",
                "DeviceNSID": "34020044991320xxxxxx",
                "CmdType": "Alarm",
                "SN": 1145,
                "ChannelID": "34020044991320xxxxxx",
                "AlarmPriority": 1,
                "AlarmMethod": 5,
                "AlarmTime": 1660046082,
                "AlarmDescription": "视频动检",
                "Longitude": "",
                "Latitude": "",
                "AlarmInfo": "11",
                "Info": {
                    "AlarmType": 2,
                    "AlarmTypeParam": {
                        "EventType": 1
                    }
                },
                "AlarmNotifyID": "b99784e3-9fc0-4a15-a40b-88a4eaxxxxxx"
            },
            {
                "AccountID": "2100xxxxxx",
                "SpaceID": "c0f4bcda-35b6-4750-b900-ec97bexxxxxx",
                "DeviceNSID": "34020044991320xxxxxx",
                "CmdType": "Alarm",
                "SN": 1146,
                "ChannelID": "34020044991320xxxxxx",
                "AlarmPriority": 1,
                "AlarmMethod": 5,
                "AlarmTime": 1660046429,
                "AlarmDescription": "视频动检",
                "Longitude": "",
                "Latitude": "",
                "AlarmInfo": "11",
                "Info": {
                    "AlarmType": 2,
                    "AlarmTypeParam": {
                        "EventType": 1
                    }
                },
                "AlarmNotifyID": "1b54c50b-0452-43a4-a26a-86f81exxxxxx"
            }
        ]
    }
}