调用该接口查询锁设备的事件记录列表。由于数据量巨大,该接口数据的查询依赖于大数据等基础设施能力,所以当前无法提供完全的实时性。90%的数据查询时延<1分钟,即在设备上报数据后1分钟内可以查询到;100%的数据查询延迟<2小时,即所有数据均可在2小时内查询到。
路径 | /lock/event/history/query |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 20000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotid | String | 是 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 | |
events | Struct | 否 | ["Door****Notification","Hijac****Alarm","DoorUnl****dAlarm"] | 需要查询的设备事件类型列表,对应产品功能定义中事件定义的标识符。为空时表示查询设备所有的事件记录。 |
start | Long | 是 | 查询时间区间的开始时间,单位:毫秒。 | |
end | Long | 是 | 查询时间区间的结束时间,单位:毫秒。 | |
lockUserId | String | 否 | 钥匙ID,由设备产生,对应锁端的锁用户ID。该参数与lockUserType均有值或均为null才有效。 | |
lockUserType | Int | 否 | 钥匙类型,与lockUserId同时有值或同时为null时有效,否则直接忽略设置。1(表示指纹);2(表示密码);3(表示卡);4(表示钥匙)。 | |
virtualUserId | String | 否 | 虚拟用户ID。同时设置该参数与lockUserId、lockUserType,会同时生效,即在虚拟用户绑定的钥匙列表的基础上加上配置的lockUserId和lockUserType。 | |
pageNo | Int | 是 | 分页页号,即从1开始当前页的序号。 | |
pageSize | Int | 是 | 分页大小。取值范围:1~50。 | |
userId | String | 否 | 淘宝账号ID信息。 | |
userType | String | 否 | 账号类型,淘宝:TAOBAO。 | |
origin | String | 否 | 标示来源,目前必须填写:TmallGenie。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
pageNo | Int |
当前的页号。 |
|
pageSize | Int |
当前分页大小。 |
|
total | Long |
查询出的记录总数。 |
|
data | JSON |
事件记录列表。 |
|
iot_id | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
event_code | String |
上报事件的标识符。 |
|
service_date | String |
服务端记录时间。格式如:2018-06-25 17:41:18。 |
|
client_date | String |
客户端上报时间。格式如:2018-06-25 17:41:18。 |
|
keyID | String |
钥匙ID,对应锁端的锁用户ID,由设备上报获得。当对应的事件具备该出参时,才包含该字段。 |
|
lockType | Int |
钥匙类型,当对应的事件具备该出参时,才包含该字段。1(表示指纹);2(表示密码);3(表示卡);4(表示钥匙)。 |
|
userLimit | Int |
钥匙权限,当对应的事件具备该出参时,才包含该字段。1(表示普通用户);2(表示管理员用户);3(表示胁迫用户) 。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1",
"iotToken": "token"
},
"params":{
"iotid": "value0",
"events":[
"Door****Notification",
"Hijac****Alarm",
"DoorUnl****dAlarm"
],
"start": "value2",
"end": "value3",
"lockUserId": "value4",
"lockUserType": "value5",
"virtualUserId": "value6",
"pageNo": "value7",
"pageSize": "value8",
"userId": "value9",
"userType": "value10",
"origin": "value11"
}
}
正常返回示例
JSON
格式
{
"code": 200,
"message": "success",
"data": [
{
"iot_id" : "ChFrkX2xxxx0803d10",
"event_code": "Door****Notification",
"service_date" : "2018-06-25 17:41:18",
"client_date": "2018-06-25 17:41:18",
"KeyID": "10",
"LockType": 2
},
{
"iot_id" : "ChFrkX2xxxx0803d10",
"event_code": "Hi****ingAlarm",
"service_date" : "2018-06-25 17:41:18",
"client_date": "2018-06-25 17:41:18",
"KeyID": "10",
"LockType": 2
},
{
"iot_id" : "ChFrkX2****0803dxx",
"event_code": "DoorUnlockedAlarm",
"service_date" : "2018-06-25 17:41:18",
"client_date": "2018-06-25 17:41:18",
"KeyID": "10",
"LockType": 2
}
]
}
异常返回示例
JSON
格式
{}
在文档使用中是否遇到以下问题
更多建议
匿名提交