文档

获取物的事件timeline数据

更新时间:
一键部署

调用该接口获取物的事件timeline数据,最多可以获取设备7天的数据。

路径 /living/device/event/timeline/get
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 10000

请求参数

名称

类型

是否必选

示例值

描述

iotId String 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
identifier String 事件的标识符。
eventType String 事件的类型。
start Long timeline开始时间,单位:毫秒。
end Long timeline结束时间,单位:毫秒。
limit Int 最大查询条数,上限为200。
order String 查询方式。asc(表示按照时间顺序查询); desc(表示按照时间逆序查询)。
origin String 调用来源。
userType String 账号类型:"TAOBAO" 、"ALIPAY" 。
userId String 账号ID。

返回数据

名称

类型

示例值

描述

code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

调用的响应结果。

timestamp Long

时间戳。

items JSON

事件列表。

eventCode String

事件标识符。

iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

eventName String

事件的名称。

eventType String

事件的类型。

eventBody String

事件的内容。

batchId String

批次ID。同一批上报的事件具有相同的批次ID。

timestamp Long

事件采集时间戳。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0",
		"iotToken": "token"
	},
	"params":{
		"iotId": "value0",
		"identifier": "value1",
		"eventType": "value2",
		"start": "value3",
		"end": "value4",
		"limit": "value5",
		"order": "value6",
		"origin": "value7",
		"userType": "value8",
		"userId": "value9"
	}
}

正常返回示例

JSON格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "items": [
            {
                "eventCode": "Error",
                "iotId": "D95D24xxxxECCE4F31A2697",
                "eventName": "故障上报",
                "eventType": "info",
                "eventBody": {
                    "ErrorCode": 0
                },
                "batchId": "5ebc6axxxx3edde6d28c8fb3",
                "timestamp": 1516342985261
            },
            {
                "eventCode": "Error",
                "iotId": "YzqEnI5xxxxo0010840500",
                "eventName": "故障上报",
                "eventType": "info",
                "eventBody": {
                    "ErrorCode": 0
                },
                "batchId": "4a0b5a7xxxxxxxx8d5ff77456f1",
                "timestamp": 1516342995305
            }
        ],
        "timestamp": 1516343075699
    }
}

异常返回示例

JSON格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}