全部产品
Search
文档中心

阿里云物联网平台:QueryDeviceOriginalPropertyData

更新时间:Apr 19, 2024

调用该接口查询指定设备本身上报的原始属性(通过和未通过物模型校验的所有属性)记录。

使用说明

仅可查询最近30天内的原始属性数据。

说明 数据存储时间从属性时间戳表示的时间当日开始计算。

QPS限制

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

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String QueryDeviceOriginalPropertyData

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

Asc Integer 0

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

  • 0:倒序。
  • 1:正序。
说明 StartTime必须小于EndTime,系统会根据排序方式自动转换。
EndTime Long 1579249499000

属性记录的结束时间。取值为13位毫秒值时间戳。

Identifier String temperature

属性的标识符。

  • 对于弱校验,设备的属性Identifier,可在控制台中设备所属的产品的功能定义中查看;也可以调用QueryThingModel,从返回的物模型信息中查看。
  • 对于免校验,必须与设备属性上报时自定义的identifier一致。
PageSize Integer 10

单个属性可返回的数据记录数量。最大值为100。

任意一个属性返回的数据记录数量不超过该值。

StartTime Long 1569249488000

要查询的属性记录的开始时间。取值为毫秒值时间戳。

IotInstanceId String iot_instc_pu****_c*-v64********

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

重要
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无实例概览页面或ID值,则无需传入。

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

ProductKey String a1BwAGV****

要查询设备所属的产品ProductKey

重要 如果传入该参数,需同时传入DeviceName
DeviceName String light

要查询的设备名称。

重要 如果传入该参数,需同时传入ProductKey
NextPageToken String Bo***x44Qx

下一页标识。如果存在下一页,服务会返回此token,下次请求带上即可。

IotId String Q7uOhVRdZRRlDnTLv****00100

要查询的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

重要 IotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKeyDeviceName。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。

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

返回数据

名称

类型

示例值

描述

Code String iot.device.InvalidIoTId

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

Data Struct

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

List Array of PropertyInfo

属性集合。每个元素代表一个属性。

PropertyInfo
Time String 1516541885630

属性修改时间。

Value String {\"data\":32.49}

属性值。

NextValid Boolean true

是否有下一页属性记录。

  • true:有。
  • false:没有。

返回NextValidtrue时,可以将NextPageToken的值作为下次查询的NextPageToken,继续查询本次查询不显示的数据。

nextPageToken String Bo***x44Qx

下一页标识。

ErrorMessage String 系统异常

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

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

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceOriginalPropertyData
&Asc=0
&EndTime=1579249499000
&Identifier=temperature
&PageSize=10
&StartTime=1569249488000
&IotId=Q7uOhVRdZRRlDnTLv****00100
&<公共请求参数>

正常返回示例

XML格式

<QueryDeviceOriginalPropertyDataResponse>
  <RequestId>DD8EE383-F007-5647-8B6B-0C52FAC3E7F2</RequestId>
  <Data>
        <NextValid>true</NextValid>
        <nextPageToken>MTcxMjc0N***********</nextPageToken>
        <List>
              <PropertyInfo>
                    <Value>{"data":31.26}</Value>
                    <Time>1712747043556</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":32.43}</Value>
                    <Time>1712747043108</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":30.58}</Value>
                    <Time>1712747042619</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":32.49}</Value>
                    <Time>1712747042182</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":30.66}</Value>
                    <Time>1712747041731</Time>
              </PropertyInfo>
        </List>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryDeviceOriginalPropertyDataResponse>

JSON格式

{
  "RequestId": "DD8EE383-F007-5647-8B6B-0C52FAC3E7F2",
  "Data": {
    "NextValid": true,
    "nextPageToken": "MTcxMjc0N***********",
    "List": {
      "PropertyInfo": [
        {
          "Value": "{\"data\":31.26}",
          "Time": 1712747043556
        },
        {
          "Value": "{\"data\":32.43}",
          "Time": 1712747043108
        },
        {
          "Value": "{\"data\":30.58}",
          "Time": 1712747042619
        },
        {
          "Value": "{\"data\":32.49}",
          "Time": 1712747042182
        },
        {
          "Value": "{\"data\":30.66}",
          "Time": 1712747041731
        }
      ]
    }
  },
  "Code": "",
  "Success": true
}

错误码

访问错误中心查看更多错误码。