Call this API to query the property snapshots of a device.

Request Parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to QueryDevicePropertyStatus.
IotId String No

The ID of the device.

Note If you use this parameter, ProductKey and DeviceName are not required. IotId is a globally unique identifier of a device, and corresponds to a combination of ProductKey and DeviceName. If you specify both IotId and the combination of ProductKey and DeviceName, the system follows IotId.
ProductKey String No

The ProductKey of the device.

Note If you use this parameter, DeviceName is required.
DeviceName String No

The name of the device.

Note If you use this parameter, ProductKey is required.
Common Request Parameters Yes See Common parameters.

Response parameters

Parameter Type Description
RequestId String The globally unique ID generated by Alibaba Cloud for the request.
Success Boolean Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.
ErrorMessage String The error message returned when the call fails.
Code String The error code returned when the call fails. For more information about error codes, see Error codes.
Data Data The property data returned when the call is successful. See the following table.
Table 1. Data
Parameter Type Description
List List The collection of property information. For detailed information, see the following table PropertyStatusInfo.
Table 2. PropertyStatusInfo
Parameter Type Description
Identifier String Identifier of a property.
Name String Name of a property.
DataType String

Property data type. Values:

int: Integer.

float: Float.

double: Double.

enum: Enumeration.

bool: Boolean.

text: Text.

date: Time (string-type UTC timestamp in milliseconds).

array: Array.

struct: Structure.

Time String The time when the property was modified.
Value String The value of the property.
Unit String The unit of the property value.

Examples

Request example 

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertyStatus
&IotId=SR8FiTu1R9tlUR2V1bmi0010*****
&Public Request Parameters

Response example

  • JSON format

    {
    "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
    "Success": true,
    "Data": {
        "List": {
            "PropertyStatusInfo": [
                {
                    "Name": "doublePropertyName",
                    "Value": "50.0",
                    "Time": "1517553572362",
                    "DataType": "double",
                    "Identifier": "doubleProperty",
                    "Unit": "C"
                }
            ]
        }
    }

  • XML format

    <? xml version='1.0' encoding='utf-8'? >
<QueryDevicePropertyStatusResponse>
    <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
    <Success>true</Success>
    <Data>
        <List>
            <PropertyStatusInfo>
                <Time>1517553572362</Time>
                <Name>doublePropertyName</Name>
                <DataType>double</DataType>
                <Identifier>doubleProperty</Identifier>
                <Value>50.0</Value>
                <Unit>C</Unit>
            </PropertyStatusInfo>
        </List>
    </Data>
</QueryDevicePropertyStatusResponse>