QueryDeviceDesiredProperty

调用该接口查询指定设备的期望属性值。

请求参数

请求方式1

名称	类型	是否必选	示例值	描述
Action	String	是	QueryDeviceDesiredProperty	系统规定参数。取值：QueryDeviceDesiredProperty。
IotInstanceId	String	是	70255861902711***	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
ProductKey	String	是	a1BwAGV****	要查询的设备所隶属的产品Key。
DeviceName	String	是	light	指定要查询的设备的名称。
Identifier.N	RepeatList	否	Temperature	要查询期望值的属性的标识符（identifier）列表。设备的属性identifier，可在控制台中，设备所属产品的功能定义中查看。单次调用，最多能查询20个标识符。请忽输入重复的属性标识符。若不传入此参数，将返回该设备所有属性的期望值。

请求方式2

名称	类型	是否必选	示例值	描述
Action	String	是	QueryDeviceDesiredProperty	系统规定参数。取值：QueryDeviceDesiredProperty。
IotInstanceId	String	是	70255861902711***	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。
IotId	String	是	70255861902711****	要查询的设备ID。
Identifier.N	RepeatList	否	Temperature	要查询期望值的属性的标识符（identifier）列表。设备的属性identifier，可在控制台中，设备所属产品的功能定义中查看。单次调用，最多能查询20个标识符。请忽输入重复的属性标识符。若不传入此参数，将返回该设备所有属性的期望值。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。
Data	Struct		调用成功时，返回的数据（List）。
List	Array		返回的期望属性信息。
DataType	String	int	属性数据类型。
Identifier	String	Temperature	属性标识符。
Name	String	airconditioning	属性名称。
Time	String	1579335899000	期望属性值的修改时间，单位是毫秒。
Unit	String	℃	属性单位。
Value	String	34	期望属性值。说明如果已调用 [ClearDeviceDesiredProperty]接口清空对应属性的期望值，则不会返回参数 Value。
Version	Long	1	当前期望属性值的版本号。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	2E6yNiZUHPeisuwWWbpxwabzf9LdmSWJ	平台为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。true：调用成功。false：调用失败。

示例

请求示例

http://open.${区域}.fenydata.com/fenydata-java-open/?Action=QueryDeviceDesiredProperty
&IotInstanceId=70255861902711****
&ProductKey=a1BwAGV****
&DeviceName=light
&<公共请求参数>

正常返回示例

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xml>
  <RequestId>128fb620eb214f80b317d6df961c6776</RequestId>
  <Data>
    <List>
      <DataType>int</DataType>
      <Identifier>int1</Identifier>
      <Name>int1</Name>
      <Time>1756288417086</Time>
      <Unit>℃</Unit>
      <Value>15</Value>
      <Version>1</Version>
    </List>
    <List>
      <DataType>int</DataType>
      <Identifier>int2</Identifier>
      <Name>int2</Name>
      <Unit>℃</Unit>
      <Version>0</Version>
    </List>
  </Data>
  <Success>true</Success>
</xml>

JSON格式

{
  "RequestId": "775f7802e4f848cfb8f975c4b5f7d31c",
  "Data": {
    "List": [
      {
        "DataType": "int",
        "Identifier": "int1",
        "Name": "int1",
        "Time": "1756288417086",
        "Unit": "℃",
        "Value": "15",
        "Version": 1
      },
      {
        "DataType": "int",
        "Identifier": "int2",
        "Name": "int2",
        "Unit": "℃",
        "Version": 0
      }
    ]
  },
  "Success": true
}