获取设备操作日志

更新时间:2023-11-23 06:31:51下载pdf

本文介绍获取设备操作日志的 API。

接口描述

根据指定事件类型,查询设备事件日志。

接口地址

GET: /v2.0/cloud/thing/{device_id}/logs

请求参数

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

返回参数

参数名类型说明
successBoolean请求是否成功。
  • true:请求成功。
  • false:请求失败。
error_codeString详见错误码。
error_msgString错误信息,成功时为空。
resultObject返回结果。

result 说明

参数名类型说明
current_row_keyString当前页开始的键值。
device_idString设备 ID。
has_nextboolean是否有下一页。
logsFusionResult日志详情。

logs 说明

参数名类型说明
event_timeLong事件发生时间。
codeString功能点 code。
event_fromString事件来源。
event_idLong事件 ID。
valueString事件值。
statusString事件状态。

请求示例

GET: /v2.0/cloud/thing/vdevo167115422036***/logs?codes=switch_led_1&type=1,2,3,4,5,6,7,8,9,10&start_time=1676944806000&end_time=1677141431000&query_type=&size=20&start_row_key=&last_row_key=&last_event_time=

返回示例

{
    "tid": "dcb6bacfbcba11eda71e169efc83a172",
    "result": {
        "current_row_key": "MTNhMmFmNjY4ZWRmOTllMmQ1ZGJhZTViZGl1dV85MjIzMzcwMzU4NjgwMTk1MTIxXzdfOQ==",
        "device_id": "uuidb5eabd5d2e99f***",
        "has_next": false,
        "logs": [
            {
                "code": "countdown_1",
                "event_from": "1",
                "event_id": 7,
                "value": "10",
                "event_time": 1678174580686,
                "status": "1"
            },
            {
                "code": "countdown_1",
                "event_from": "1",
                "event_id": 7,
                "value": "10",
                "event_time": 1678174579758,
                "status": "1"
            },
            {
                "code": "countdown_1",
                "event_from": "1",
                "event_id": 7,
                "value": "10",
                "event_time": 1678174578453,
                "status": "1"
            }
        ]
    },
    "t": 1678174631163,
    "success": true
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制