更新时间:2022-07-13 GMT+08:00
分享

根据标签查询设备历史值

功能介绍

根据标签查询设备历史值

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/data-stores/{data_store_id}/property-values/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:1

最大长度:128

data_store_id

String

存储ID

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token

最小长度:1

最大长度:65535

表3 请求Body参数

参数

是否必选

参数类型

描述

time_span

TimeSpan object

起止时间范围

tags

map<string, object>

对property按指定tags标签进行过滤查询,填入设备标签与标签值,不可为空,例如 {"deviceId": "id0001"}

property_names

Array of strings

查询的属性列表

limit

Integer

返回值个数限制

最小值:1

最大值:2000

缺省值:100

表4 TimeSpan

参数

是否必选

参数类型

描述

from

String

起始时间

最小长度:1

最大长度:64

to

String

结束时间

最小长度:1

最大长度:64

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

timestamps

Array of strings

时间序列

properties

Array of HistoryValues objects

查询设备的属性值

表6 HistoryValues

参数

参数类型

描述

property_name

String

属性名称

values

Array of objects

属性值

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误消息

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误消息

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误消息

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误消息

请求示例

{
  "time_span" : {
    "from" : "2021-02-01T00:00:00.123Z",
    "to" : "2021-02-05T20:00:00.100Z"
  },
  "tags" : {
    "deviceId" : "IA2006300"
  },
  "property_names" : [ "prop_1", "prop_2" ],
  "limit" : 100
}

响应示例

状态码: 200

OK

{
  "timestamps" : [ "2021-01-08T02:03:42.000Z", "2021-01-08T02:03:41.907Z" ],
  "properties" : [ {
    "property_name" : "prop_1",
    "values" : [ 1, 2 ]
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品