简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

查询设备日志

更新时间:2022-09-08 07:49:20下载pdf

本文介绍查询设备日志的 API。

接口描述

根据条件查询设备操作历史记录。

接口地址

GET: /v1.0/devices/{device_id}/logs

请求参数

参数名类型参数位置是否必填说明
device_idStringuritrue设备ID
codesStringqueryfalse设备支持的功能点。支持多个功能点的查询,用半角逗号(,)隔开,默认为空
typeStringquerytrue日志查询支持的类型。支持多个事件类型的查询,用半角逗号(,)隔开,必传。(1 上线,2 下线,3 设备激活,4 设备重置,5 指令下发,6 固件升级,7 数据点上报,8 设备信号量,9 设备重启,10 定时信息)
start_row_keyStringqueryfalse免费版参数,查询 Hbase 的行键。默认值为空
start_timeLongquerytrue查询的开始时间戳,13位
end_timeLongquerytrue查询的结束时间戳,13位
query_typeIntegerqueryfalse查询类型,默认为 1,(1 免费版,2 收费版)
last_row_keyStringqueryfalse收费版分页参数,最后一条数据的行键。默认值为空,查第一页,收费版必传
last_event_timeLongqueryfalse收费版分页参数,最后一条数据的事件发生时间(默认为空查第一页,收费版必传)
sizeIntegerqueryfalse查询的日志数量大小(默认为 20)

返回参数

参数名类型说明
resultDeviceLogResultRes

result 说明

参数名类型说明
device_idString设备ID
has_nextBoolean是否还有下一条,true 有,false 没有
current_row_keyString免费版参数,Hbase 的当前行键。
next_row_keyString免费版参数,下一条满足查询条件的 Hbase 行键,如果返回值为 null,表示为没有满足查询条件的下一条日志。
logsList日志消息体
countLong收费版参数,满足查询条件的日志总数

logs 说明

参数名类型说明
codeString功能点Code
valueObject功能点的值
event_timeLong事件发生的时间戳
event_fromString事件触发的来源,(1 设备本身,2 客户端指令,3 第三方平台,4 云端指令,-1 未知)
event_idShort事件的类型,(1 上线,2 下线,3 设备激活,4 设备重置,5 指令下发,6 固件升级,7 数据点上报,8 设备信号量,9 设备重启,10 定时信息)
rowString收费版参数,为当前 Hbase 行键
statusString数据有效,没有被删除。默认值为'1'

请求示例

GET: /v1.0/devices/xxxid/logs?start_row_key=xxxx_1&type=1,2&start_time=1545898159931&end_time=1545898159935&size=20

返回示例

{
    "device_id": "75500780ecfabc9a****",
    "current_row_key": "NjUwODIzNDU1ZjY4YTljYmFmY2UwODcwMDU1N185MjIzMzcwNDc1OTgyMjA3ODUyXzdfMQ==",
    "next_row_key": "NjUwODIzNDU1ZjY4YTljYmFmY2UwODcwMDU1N185MjIzMzcwNDc2MDcxNDk5OTM0XzdfMQ==",
    "has_next": true,
    "logs": [
        {
            "code": "switch_1",
            "event_from": "1",
            "event_id": 7,
            "value": "false",
            "event_time": 1560872567955
        },
        {
            "code": "switch_1",
            "event_from": "1",
            "event_id": 7,
            "value": "false",
            "event_time": 1560783276382
        }
    ]
}

错误码

参考 错误码