报警列表查询V3--慢直播-火山引擎

文档中心

立即注册

导航

报警列表查询V3

最近更新时间：2025.02.14 16:29:36首次发布时间：2025.02.14 16:29:36

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListDeviceAlarms&Version=2023-10-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListDeviceAlarms`	接口名称。当前 API 的名称为 `ListDeviceAlarms`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。
PageSize	Integer	否	`10`	分页大小
PageNumber	Integer	否	`1`	分页

Body

参数	类型	是否必选	示例值	描述
DeviceID	String	是	`a4a17959-e3c5-4cae-98cd-03410b7192d6`	设备ID，可通过调用 ListDevices 接口获取
StreamID	String	否	`48d69d60-1a94-4dbb-91a1-3cb75065a7da`	视频流ID，可通过调用 ListStreams 接口获取
StartTime	Long	是	`1660031340`	查询起始时间，秒级时间戳，例如：1660031340
EndTime	Long	是	`1660048340`	查询结束时间，秒级时间戳，例如：1660041340
Order	Integer	否	`0`	排序方式： 0（正序）其他（倒序）
AlarmMethod	Array of Integer	是	`[5]`	告警方式筛选条件，可选枚举值为（如传入空数组，即返回所有告警方式的报警记录）： 1（电话报警） 2（设备报警） 3（短信报警 4（GPS报警） 5（视频报警） 6（设备故障报警） 7（其他报警）
AlarmPriority	Array of Integer	是	`[2]`	报警级别筛选条件，可选枚举值为（如传入空数组，即返回所有告警级别的报警记录）： 1（一级警情） 2（二级警情） 3（三级警情） 4（四级警情）

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PageNumber	Integer	`1`
PageSize	Integer	`20`
TotalCount	Integer	`2`
AlarmNotifies	Array of AlarmNotifies	`-`	查询到的报警信息列表，参考以下 `List<AlarmNotifies>` 数据结构说明

AlarmNotifies

参数	类型	示例值	描述
DeviceNSID	String	`34020044991320xxxxxx`	设备国标 ID
ChannelID	String	`34020044991320xxxxxx`	通道 ID
AlarmNotifyID	String	`1b54c50b-0452-43a4-a26a-86f81exxxxxx`	报警记录 ID
AlarmPriority	Integer	`1`	报警级别： 1（一级警情） 2（二级警情） 3（三级警情） 4（四级警情）
AlarmMethod	Integer	`5`	报警方式： 1（电话报警） 2（设备报警） 3（短信报警 4（GPS报警） 5（视频报警） 6（设备故障报警） 7（其他报警）
AlarmTime	Long	`1660046429`	报警时间
AlarmDescription	String	`视频动检`	报警内容描述
Longitude	String	`25.2`	设备经度
Latitude	String	`52.1`	设备纬度

请求示例

POST https://open.volcengineapi.com?Action=ListDeviceAlarms&Version=2023-10-01&PageSize=10&PageNumber=1
{
  "DeviceID": "a4a17959-e3c5-4cae-98cd-03410b7192d6",
  "StartTime": 1660031340,
  "EndTime": 1660048340,
  "AlarmMethod": [
    5
  ],
  "AlarmPriority": [
    2
  ],
  "StreamID": "48d69d60-1a94-4dbb-91a1-3cb75065a7da",
  "Order": 0
}

返回示例

{
  "Result": {
    "PageNumber": 1,
    "TotalCount": 2,
    "PageSize": 20,
    "AlarmNotifies": "-"
  },
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Version": "2023-10-01",
    "Action": "ListDeviceAlarms",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。