查询设备日志

更新时间：2023-12-07 03:33:52下载pdf

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

接口描述

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

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
device_id	String	uri	true	设备ID
codes	String	query	false	设备支持的功能点。支持多个功能点的查询，用半角逗号（,）隔开，默认为空
type	String	query	true	日志查询支持的类型。支持多个事件类型的查询，用半角逗号（,）隔开，必传。(1 上线,2 下线,3 设备激活,4 设备重置,5 指令下发,6 固件升级,7 数据点上报,8 设备信号量,9 设备重启,10 定时信息)
start_row_key	String	query	false	免费版参数，查询 Hbase 的行键。默认值为空
start_time	Long	query	true	查询的开始时间戳,13位
end_time	Long	query	true	查询的结束时间戳,13位
query_type	Integer	query	false	查询类型，默认为 1,(1 免费版,2 收费版)
last_row_key	String	query	false	收费版分页参数，最后一条数据的行键。默认值为空，查第一页，收费版必传
last_event_time	Long	query	false	收费版分页参数，最后一条数据的事件发生时间（默认为空查第一页，收费版必传）
size	Integer	query	false	查询的日志数量大小（默认为 20）

返回参数

参数名	类型	说明
result	DeviceLogResultRes

result 说明

参数名	类型	说明
device_id	String	设备ID
has_next	Boolean	是否还有下一条,true 有,false 没有
current_row_key	String	免费版参数，Hbase 的当前行键。
next_row_key	String	免费版参数，下一条满足查询条件的 Hbase 行键,如果返回值为 null，表示为没有满足查询条件的下一条日志。
logs	List	日志消息体
count	Long	收费版参数，满足查询条件的日志总数

logs 说明

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

请求示例

GET: /v1.0/devices/6c9395918f4f4d85d8****/logs?end_time=1699433821000&start_time=1699433221000&type=1,2,7

返回示例

{
    "tid": "a45cea067e1411eeaf49161d7283****",
    "result": {
        "current_row_key": "ZWM1N2U0MzQxd3htOGQ1OGQ0ZjRmODE5NTkzOWM2XzkyMjMzNzAzMzc0MjEwMTU4NjFf****",
        "device_id": "6c9395918f4f4d85d8****",
        "next_row_key": "ZWM1N2U0MzQxd3htOGQ1OGQ0ZjRmODE5NTkzOWM2XzkyMjMzNzAzMzc0MjExMjc4NDVf****",
        "has_next": true,
        "logs": [
            {
                "code": "target_dis_closest",
                "event_from": "1",
                "event_id": 7,
                "value": "202",
                "event_time": 1699433759946,
                "status": "1"
            },
            {
                "code": "target_dis_closest",
                "event_from": "1",
                "event_id": 7,
                "value": "210",
                "event_time": 1699433758927,
                "status": "1"
            }
        ]
    },
    "t": 1699433761797,
    "success": true
}

错误码

参考错误码。