QueryDevicePropertyData

调用接口QueryDevicePropertyData查询指定设备或IoT孪生节点,在指定时间段内,单个属性的数据。

使用说明

  • 若设备或数字孪生节点有多个属性,您可以多次调用本接口,一次输入一个Identifier进行查询,也可以直接调用接口QueryDevicePropertiesData,一次输入多个Identifier进行查询。
  • 若查询数字孪生节点的属性数据,必须传入参数IotId,且取值为孪生节点ID。

使用限制

  • 标准型和尊享型企业版实例:仅可查询存储时效内的数据。数据存储时效,请参见存储配置
  • 其他实例:仅可查询最近30天内的属性数据。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String QueryDevicePropertyData

系统规定参数。取值:QueryDevicePropertyData。

EndTime Long 1579249499000

要查询的属性记录的结束时间,必须大于起始时间StartTime。取值为毫秒值时间戳,例如:1579249499000。

Asc Integer 0

返回结果中属性记录的排序方式,取值:

  • 0:倒序。
  • 1:正序。
Identifier String temperature

要查询的属性标识符。

  • 设备的属性Identifier,可在物联网平台控制台中设备所属的产品的功能定义中查看,或调用QueryThingModel,从返回的物模型数据中查看。
  • 数字孪生节点的属性Identifier,可在物联网平台控制台中数字孪生工作台下的孪生节点的功能属性中查看。具体操作,请参见孪生节点的功能属性
说明 如果设备的属性是自定义(非默认)模块testFb下属性temperature,则参数值为testFb:temperature
PageSize Integer 10

返回结果中每页显示的记录数。数量限制:每页最多可显示50条。

StartTime Long 1579249499000

要查询的属性记录的开始时间,必须小于结束时间EndTime。取值为毫秒值时间戳,例如:1579249499000。

IotInstanceId String iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

重要
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见实例概述

IotId String Q7uOhVRdZRRlDnTLv****00100

要查询属性所属的设备ID或数字孪生节点ID

  • 调用QueryDeviceInfo接口,可查询指定设备的IotId
  • 在物联网平台控制台的数字孪生体详情页面,单击孪生节点,可查看节点ID
重要 IotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKeyDeviceName。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。
ProductKey String a1BwAGV****

要查询设备所属的产品ProductKey。

重要

如果传入该参数,需同时传入DeviceName

DeviceName String airconditioning

要查询设备的名称。

重要

如果传入该参数,需同时传入ProductKey

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称

类型

示例值

描述

Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

Data Struct

调用成功时,返回的设备属性记录。

List Array of PropertyInfo

属性数据列表。

PropertyInfo
Time String 1516541885630

属性修改时间。

Value String 2

属性值。

NextTime Long 1579249499000

下一页面中的属性记录的起始时间。

  • 当属性记录的排序方式为倒序(入参Asc0),调用本接口查询下一页属性记录时,该值可作为下次查询的入参EndTime的值。
  • 当属性记录的排序方式为正序(入参Asc1),调用本接口查询下一页属性记录时,该值可作为下次查询的入参StartTime的值。
NextValid Boolean true

是否有下一页属性记录。

  • true:有,返回NextTime。详细说明,请参见NextTime描述。
  • false:没有。
ErrorMessage String 系统异常

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

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertyData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=lightLevel
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<公共请求参数>

正常返回示例

XML格式

<QueryDevicePropertyDataResponse>
  <Data>
        <NextValid>false</NextValid>
        <NextTime>1579249151177</NextTime>
        <List>
              <PropertyInfo>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
              </PropertyInfo>
        </List>
  </Data>
  <RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
  <Success>true</Success>
</QueryDevicePropertyDataResponse>

JSON格式

{
  "Data": {
    "NextValid": false, 
    "NextTime": 1579249151177, 
    "List": {
      "PropertyInfo": [
        {
          "Value": "32.46", 
          "Time": 1579249151178
        }
      ]
    }
  }, 
  "RequestId": "45391E10-446B-4986-863E-1BA8CC44748F", 
  "Success": true
}