获取设备事件日志

更新时间:2024-01-30 09:30:01下载pdf

本文介绍获取设备事件日志的 API。

接口描述

获取设备上线、下线、设备激活和设备重置等事件的日志。

接口地址

GET: /v1.0/iot-03/devices/{device_id}/logs

请求参数

参数名类型参数位置是否必填说明
device_idStringuritrue设备 ID。
event_typesStringquerytrue日志查询支持的事件类型。支持多个事件类型的查询,用半角逗号(,)隔开,必传。有效值:
  • 1:设备上线
  • 2:设备下线
  • 3:设备激活
  • 4:设备重置
  • 6:固件升级
  • 8:设备信号量
  • 9:设备重启
  • 10:定时信息
start_timeLongquerytrue查询的开始时间戳,13 位。
end_timeLongquerytrue查询的结束时间戳,13 位。
sizeIntegerqueryfalse查询的日志数量大小,默认为 20
query_typeIntegerqueryfalse查询类型。有效值:
  • 1:免费版,默认为 1
  • 2:收费版
last_row_keyStringqueryfalse分页参数,为上一页请求返回值中的 last_row_key。传参为空时,查询第一页。

返回参数

参数名类型说明
resultDeviceLogRes基础分页信息。

result 说明

参数名类型说明
last_row_keyString当前页的标识,可作为下一页查询的请求 last_row_key 参数值。
device_idString设备 ID。
has_moreBoolean是否有下一页。
listList数据列表。

list 说明

参数名类型说明
event_timeLong事件时间。
event_fromString事件触发的来源。有效值:
  • 1:设备本身
  • 2:客户端指令
  • 3:第三方平台
  • 4:云端指令
  • -1:未知
event_idInteger事件的类型。有效值:
  • 1:上线
  • 2:下线
  • 3:设备激活
  • 4:设备重置
  • 6:固件升级
  • 8:设备信号量
  • 9:设备重启
  • 10:定时信息
event_valueString事件值。

请求示例

GET: /v1.0/iot-03/devices/xxxxx/logs?last_row_key=xxx&event_types=1,2&start_time=1545898159931&end_time=1545898159935&size=20

返回示例

{
    "result": {
        "last_row_key": "xxxxxxxxxxxxx",
        "device_id": "75500780ecfabc9a****",
        "has_next": true,
        "logs": [
            {
                "code": "switch_1",
                "event_from": "1",
                "event_id": 7,
                "value": "false",
                "event_time": 1560872567955
            }
        ]
    },
    "t": 1561344464370,
    "success": true
}

错误码

参考 错误码