调用该接口查询指定设备或IoT孪生节点的所有属性快照。

使用说明

若查询IoT孪生节点的属性数据，必须传入参数IotId，且取值为孪生节点ID。

QPS限制

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryDevicePropertyStatus

系统规定参数。取值：QueryDevicePropertyStatus。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

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

实例的更多信息，请参见实例概述。
ProductKey String 否 a1BwAGV****

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

重要

如果传入该参数，需同时传入DeviceName。
DeviceName String 否 light

要查询的设备名称。

重要

如果传入该参数，需同时传入ProductKey。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

要查询属性所属的设备ID或IoT孪生节点ID：

  • 调用QueryDeviceInfo接口，可查询指定设备的IotId。
  • 在物联网平台控制台的孪生实体图页面，单击孪生节点，可查看节点ID。
重要

IotId作为设备唯一标识符，和ProductKey与DeviceName组合是一一对应的关系。如果传入该参数，则无需传入ProductKey和DeviceName。如果您同时传入IotId和ProductKey与DeviceName组合，则以IotId为准。
FunctionBlockId String 否 BatteryModule

物模型自定义模块标识符，在产品中具有唯一性。

不传入此参数时，查询默认模块的数据。

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

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

调用成功时，返回的数据，详情请参见List包含的参数。
List Array of PropertyStatusInfo

返回的属性集合信息（PropertyStatusInfo）。
PropertyStatusInfo
DataType String int

属性格式类型，取值：

  • int：整型。
  • float：单精度浮点型。
  • double：双精度浮点型。
  • enum：枚举型。
  • bool：布尔型。
  • text：字符型。
  • date：时间型（String类型的UTC时间戳，单位是毫秒）。
  • array：数组型。
  • struct：结构体类型。
Identifier String Temperature

属性标识符。
Name String temperature

属性名称。
Time String 1517553572362

属性修改的时间，单位是毫秒。
Unit String °C

属性值的单位。
Value String 25

属性值。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

表示是否调用成功。

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

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertyStatus
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公共请求参数>

正常返回示例

XML格式

<QueryDevicePropertyStatusResponse>
  <Data>
        <List>
              <PropertyStatusInfo>
                    <Name>湿度</Name>
                    <Value>48</Value>
                    <Time>1579249151178</Time>
                    <DataType>int</DataType>
                    <Identifier>Humidity</Identifier>
                    <Unit>%</Unit>
              </PropertyStatusInfo>
              <PropertyStatusInfo>
                    <Name>温度</Name>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
                    <DataType>float</DataType>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </PropertyStatusInfo>
        </List>
  </Data>
  <RequestId>84BAD25B-9879-4BA1-9213-F576C6558D77</RequestId>
  <Success>true</Success>
</QueryDevicePropertyStatusResponse>

JSON格式

{
	"Data": {
		"List": {
			"PropertyStatusInfo": [
				{
					"Name": "湿度",
					"Value": "48",
					"Time": "1579249151178",
					"DataType": "int",
					"Identifier": "Humidity",
					"Unit": "%"
				},
				{
					"Name": "温度",
					"Value": "32.46",
					"Time": "1579249151178",
					"DataType": "float",
					"Identifier": "Temperature",
					"Unit": "°C"
				}
			]
		}
	},
	"RequestId": "84BAD25B-9879-4BA1-9213-F576C6558D77",
	"Success": true
}

错误码

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