查询设备历史数据
请求方式:GET
URL: http://api.heclouds.com/devices/device_id/datapoints
device_id:需要替换为设备ID
URL参数
参数名称 |
格式 |
是否必须 |
说明 |
datastream_id |
string |
否 |
数据流ID,多个id之间用逗号分开,缺省时为查询所有数据流 |
start |
string |
否 |
提取数据点的开始时间,精确到秒,示例:2015-01-10T08:00:35 |
end |
string |
否 |
提取数据点的结束时间,精确到秒,示例:2015-01-10T08:00:35 |
duration |
int |
否 |
查询时间区间,单位为秒 |
limit |
int |
否 |
限定本次请求最多返回的数据点数,默认100,范围为(0,6000] |
cursor |
string |
否 |
指定本次请求继续从cursor位置开始提取数据 |
sort |
enum |
否 |
时间排序方式,DESC:倒序,ASC:升序,默认为ASC |
返回参数
参数名称 |
格式 |
说明 |
errno |
int |
调用错误码,为0表示调用成功 |
error |
string |
错误描述,为"succ"表示调用成功 |
data |
json |
接口调用成功之后返回的设备相关信息,见data描述表 |
data描述表
参数名称 |
格式 |
说明 |
count |
string |
本次返回的数据点数量 |
cursor |
string |
本次请求若未能返回所有数据,则会返回cursor参数,用户可以携带cursor参数进行再次请求,获取剩下的数据 |
datastreams |
array-json |
设备数据流信息的json数组,见datastreams描述表 |
datastreams描述表
参数名称 |
格式 |
说明 |
id |
string |
数据流名称 |
datapoints |
array-json |
数据点信息的json数组,见datapoints描述表 |
datapoints描述表
参数名称 |
格式 |
说明 |
at |
string |
数据记录时间 |
value |
string/int/json... |
数据点的值 |
请求示例1
请求设备8029377从2017年1月1日零点以来,数据流ds的第1至第100条数据
GET http://api.heclouds.com/devices/8029377/datapoints?datastream_id=ds&start=2017-01-01T00:00:00&limit=100 HTTP/1.1
返回示例1
{
"errno": 0,
"data": {
"cursor": "83900_8029377_1498708525203",
"count": 100,
"datastreams": [{
"datapoints": [{
"at": "2017-06-23 11:09:46.281",
"value": "112312"
}, {
"at": "2017-06-23 11:09:58.799",
"value": "112312"
}, {
"at": "2017-06-23 11:09:58.802",
"value": "1213"
}, {
"at": "2017-06-23 11:10:17.962",
"value": "1"
},
...
{
"at": "2017-06-29 11:55:20.198",
"value": "hello"
}],
"id": "ds"
}]
},
"error": "succ"
}
本示例中,只返回了2017年1月1日零点以来的前100条数据,若需要继续获取接下来的数据,需要在请求时添加cursor参数,并可以增加每次请求的返回数量参数limit,如示例2:
请求示例2
获取2017年1月1日零点以来的第101条数据,到第1100条数据
GET http://api.heclouds.com/devices/8029377/datapoints?datastream_id=ds&start=2017-01-01T00:00:00&limit=1000&cursor=83900_8029377_1498708525203 HTTP/1.1
返回示例2
{
"errno": 0,
"data": {
"count": 1000,
"datastreams": [{
"datapoints": [{
"at": "2017-06-23 11:10:41.475",
"value": "awefa"
}, {
"at": "2017-06-23 11:11:12.839",
"value": "ad3"
},
...
{
"at": "2017-06-25 11:13:54.249",
"value": "RA414124124124"
}, {
"at": "2017-06-25 21:07:43.024",
"value": "13dfadfafzfadf#123affad"
}],
"id": "ds"
}]
},
"error": "succ"
}