开发者平台

TP-LINK官网首页
开发者平台 / 视频管理系统(VMS)/ API功能接口定义 / 直播管理

4.11 报警输出

4.11.1 获取报警日志信息

接口说明:

名称 内容
URL https://xxx/tums/logManager/v1/queryAlarmLog
功能说明 获取报警日志信息
使用限制

请求参数:

参数名称 参数描述
start
long
要获取的起始条目
限制:必选参数
limit
int
要获取的条目总数
限制:必选参数,[1, 100]
filterAnd
Map
获取的数据要同时匹配filterAnd中的数据
1.必选参数;
2.包含一组key/value,key必须是如下的参数之一,必须包括必选参数:
名称 内容
alarmObj
String
报警设备的名称
限制:可选参数,过滤类型为equal
alarmName
String
报警名称,如“移动侦测”、“设备离线”等
限制:可选参数,过滤类型为equal
alarmSourceType
String
报警源类型,如“监控点报警”、“设备报警”等
限制:可选参数,过滤类型为equal
projectId
String
项目ID
限制:必选参数,过滤类型为equal
readMark
int
日志是否已读标识
限制:可选参数,过滤类型为equal
screenWarningMark
int
是否有报警标识
限制:可选参数,过滤类型为equal
videoMark
int
是否有视频
限制:可选参数,过滤类型为equal
systemType
String
系统类型
限制:为“客控”,“网络”、“监控”中的一个,过滤类型为equal
sourceId
String
报警源标识
限制:可选参数,过滤类型为equal
contentLike
String
日志条目中包含的字段
限制:可选参数,过滤类型为like,后台自动额外对alarmObj,alarmName和alarmType执行like匹配
logTimeGe
long
日志时间大于
限制:可选参数,过滤类型为greatOrEqual
logTimeLe
String
日志时间小于
限限制:可选参数,过滤类型为lessOrEqual
3.接口中声明的是key的合集,实际调用可以是key的子集;
filterOr
Map
(未启用,无须设置)
sort
List
表示返回数据的排序方式
限制:
1.可选参数;
2.包含一组key/value,key可以为”alarmName, alarmObj, systemType, logTime”:
3.value为asc/desc,分别表升序和降序

返回参数:

参数名称 参数描述
error_code 返回码,0 – 成功,其他- 失败,具体请参考返回码章节
result
List
total
int
满足条件的日志条目数
list
List<log>
日志信息列表,具体字段有:
名称 内容
logId
long
日志ID
logTime
long
日志时间,需要前端自行转换为GMT格式
alarmObj
String
报警设备名称
alarmName
String
报警名称
alarmSourceType
String
报警源类别
sourceId
String
触发源ID:
如服务器ID,监控点ID
screenWarningMark
int
是否设置了屏幕报警
readMark
int
是否显示为未读消息
videoMark
int
是否存在联动录像
projectId
int
项目ID
systemType
String
系统类型为“--”“客控”,“网络”、“监控”中的一个
triggerSourceType
String
触发报警的源类型,VMS的取值范围为:IPC、NVR、DECODER、SERVER

代码示例

        https://xxx/tums/logManager/v1/queryAlarmLog 
        request:
        {
            "start":0,
            "limit":10,
            "filterAnd":{"readMark":0, "projectId":"123"},
            "sort": [{"logTime": "asc"}]
        }
        response:
        {
        "result": {
        "total": 2,
        "list": [
                {
                    "logId": 1,
                    "logTime": 1536918012959,
                    "alarmObj": "IPC客厅",
                    "alarmName": "移动侦测",
                    "alarmSourceType": "监控点报警",
                    "projectId": "123",
                    "sourceId": "srcIDSample",
                    "screenWarningMark": 0,
                    "readMark": 0,
                    "videoMark": 0,
                    "systemType": "监控",
                    "triggerSourceType": "IPC"
                },
                {
                    "logId": 2,
                    "logTime": 1536918012974,
                    "alarmObj": "IPC走廊",
                    "alarmName": "设备离线",
                    "alarmSourceType": "设备报警",
                    "projectId": "123",
                    "sourceId": "srcIDSample",
                    "screenWarningMark": 1,
                    "readMark": 0,
                    "videoMark": 0,
                    "systemType": "监控",
                    "triggerSourceType": "IPC"
                },
        ]
        },
            "error_code": 0
        }