全部产品
Search
文档中心

阿里云物联网平台:QueryDeviceOriginalPropertyStatus

更新时间:Oct 11, 2024

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

QPS限制

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

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String QueryDeviceOriginalPropertyStatus

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

Asc Integer 0

指定查询属性数据的字典排序方式。取值:

  • 0:根据返回参数Identifier的值,按照字典倒序。
  • 1:根据返回参数Identifier的值,按照字典正序。
PageSize Integer 10

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

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.common.InvalidPageParams

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

Data Struct

调用成功时,返回的数据,更多信息,请参见List包含的参数。

List Array of PropertyStatusDataInfo

返回的属性集合信息(PropertyStatusInfo)。

PropertyStatusDataInfo
Identifier String Temperture

属性标识符。

Time Long 1517553572362

属性修改的时间,单位是毫秒。

Value String 26

属性值。

NextPageToken String Bo***x44Qx

下一页标识。

NextValid Boolean true

是否有下一页属性记录。

  • true:有。
  • false:没有。

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

ErrorMessage String 系统异常

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

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

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

Success Boolean true

表示是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceOriginalPropertyStatus
&Asc=0
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<QueryDeviceOriginalPropertyStatusResponse>
  <Data>
        <NextValid>false</NextValid>
        <nextPageToken>Bo***x44Qx</nextPageToken>
        <List>
              <PropertyStatusInfo>
                    <Value>48</Value>
                    <Time>1579249151178</Time>
                    <Identifier>Humidity</Identifier>
              </PropertyStatusInfo>
              <PropertyStatusInfo>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
                    <Identifier>Temperature</Identifier>
              </PropertyStatusInfo>
        </List>
  </Data>
  <RequestId>84BAD25B-9879-4BA1-9213-F576C6558D77</RequestId>
  <Success>true</Success>
</QueryDeviceOriginalPropertyStatusResponse>

JSON格式

{
	"Data": {
        "NextValid": false, 
        "nextPageToken": "Bo***x44Qx", 
		"List": {
			"PropertyStatusInfo": [
				{
					"Value": "48",
					"Time": "1579249151178",
					"Identifier": "Humidity"
				},
				{
					"Value": "32.46",
					"Time": "1579249151178",
					"Identifier": "Temperature"
				}
			]
		}
	},
	"RequestId": "84BAD25B-9879-4BA1-9213-F576C6558D77",
	"Success": true
}

错误码

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