Queries the property snapshot of a specified device.


Each Alibaba Cloud account can run a maximum of 200 queries per second (QPS).

Note Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryDevicePropertyStatus

The operation that you want to perform. Set the value to QueryDevicePropertyStatus.

IotInstanceId String No iot_instc_pu****_c*-v64********

The instance ID. This parameter is not required for public instances. However, this parameter is required for Enterprise Edition instances.

ProductKey String No a1BwAGV****

The key of the product to which the device belongs.

Note If you specify this parameter, you must also specify the DeviceName parameter.
DeviceName String No light

The name of the device.

Note If you specify this parameter, you must also specify the ProductKey parameter.
IotId String No Q7uOhVRdZRRlDnTLv****00100

The ID of the device. The ID of the device. The ID is the unique identifier that is issued by IoT Platform to the device. You can call the QueryDeviceDetail operation to query the value of this parameter for a specified device.

Note If you specify this parameter, you do not need to specify the ProductKey or DeviceName parameter. The IotId parameter specifies a unique identifier for the device, and corresponds to a combination of the ProductKey and DeviceName parameters. If you specify the IotId parameter and a combination of the ProductKey and DeviceName parameters at the same time, the IotId parameter takes precedence.
FunctionBlockId String No BatteryModule

The identifier of a Thing Specification Language (TSL)-based custom module. Each identifier is unique in a product.

If you do not specify this parameter, the system queries the data of the default module.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

Data Struct

The data returned if the call succeeds. For more information, see List.

List Array of PropertyStatusInfo

The array of property information. The information about each property is indicated by the PropertyStatusInfo parameter.

DataType String int

The data type of the property. Valid values:

  • int: integer
  • float: single-precision floating-point number
  • double: double-precision floating-point number
  • enum: enumeration
  • bool: Boolean
  • text: character
  • date: time (string-type UTC timestamp in milliseconds)
  • array: array
  • struct: structure
Identifier String Temperture

The identifier of the property.

Name String temperature

The name of the property.

Time String 1517553572362

The time when the property was modified, in milliseconds.

Unit String °C

The unit of the property value.

Value String 25

The value of the property.

ErrorMessage String A system exception has occurred.

The error message returned if the call fails.

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

The ID of the request.

Success Boolean true

Indicates whether the call succeeds.

  • true: The call succeeded.
  • false: The call failed.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

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

Error codes

For a list of error codes, visit the API Error Center.