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

限制说明

  • 只读属性不支持查询期望属性值。
  • 一次调用最多能查询10个属性的期望值。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:QueryDeviceDesiredProperty
IotId String

要查询的设备ID。

说明 如果传入该参数,则无需传入 ProductKeyDeviceNameIotId作为设备唯一标识符,与 ProductKey & DeviceName组合是一一对应的关系。如果您同时传入 IotIdProductKeyDeviceName组合,则以 IotId为准。
ProductKey String

要查询的设备所隶属的产品Key。

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

要查询的设备的名称。

说明 如果传入该参数,需同时传入 ProductKey
Identifiers List

要查询期望值的属性的标识符 (identifier) 列表。

设备的属性identifier,可在控制台中,设备所属产品的功能定义中查看。

说明
  • 单次调用,最多能传入10个identifier。
  • 不可输入重复的属性identifier。
  • 若不传入此参数,将返回该设备所有属性的期望值。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
Data Data 调用成功时,返回的数据。详情参见下表。
表 1. Data
名称 类型 描述
List List<DesiredPropertyInfo> 返回的属性信息。详情参见下表DesiredPropertyInfo。
表 2. DesiredPropertyInfo
名称 类型 描述
Identifier String 属性标识符。
Name String 属性名称。
DataType String 属性数据类型。
Time String 期望属性值的修改时间,单位是毫秒。
Value String 期望属性值。
Unit String 属性单位。
Version Long

当前期望属性值的版本号。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDesiredProperty
&IotId=SR8FiTu1R9tlUR2V1bmi0010*****
&Identifier.1=Weight
&Identifier.2=Circle
&公共请求参数

返回示例

  • JSON 格式
    {
        "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
        "Success": true,
        "Data":{
            "List":{
                "DesiredPropertyInfo":[
                    {
                        "Name": "WeightName",
                        "Value": "50.0",
                        "Time": "1517553572362",
                        "DataType": "double",
                        "Identifier": "Weight",
                        "Unit": "C",
                        "Version": 10
                    },
    		{
                        "Name": "CircleName",
                        "Value": "50.0",
                        "Time": "1517553572362",
                        "DataType": "double",
                        "Identifier": "Circle",
                        "Unit": "C",
                        "Version": 10
                    }
                ]
            }
        }
    }
  • XML格式
    <?xml version='1.0' encoding='utf-8'?>
    <QueryDeviceDesiredPropertyResponse>
        <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
        <Success>true</Success>
        <Data>
            <List>
                <DesiredPropertyInfo>
                    <Time>1517553572362</Time>
                    <Name>doublePropertyName</Name>
                    <DataType>double</DataType>
                    <Identifier>doubleProperty</Identifier>
                    <Value>50.0</Value>
                    <Unit>C</Unit>
                    <Version>10</Version>
                </DesiredPropertyInfo>
                <DesiredPropertyInfo>
                    <Time>1517553572362</Time>
                    <Name>CircleName</Name>
                    <DataType>double</DataType>
                    <Identifier>Circle</Identifier>
                    <Value>50.0</Value>
                    <Unit>C</Unit>
                    <Version>10</Version>
                </DesiredPropertyInfo>
            </List>
        </Data>
    </QueryDeviceDesiredPropertyResponse>