Query Desired Properties

Last Updated on : 2024-09-10 01:49:16

Based on the device ID, query the list of desired properties of the specified device.

API address

GET: /v2.0/cloud/thing/{device_id}/shadow/properties/desired

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
codes	String	query	false	The list of property codes, separated with commas (,).

Return parameter

Parameter name	Type	Description
result	Object	The returned result.

Description of result

Parameter name	Type	Description
properties	List	The list of desired properties.

Description of properties

Parameter name	Type	Description
dpId	Integer	The ID of the specified property.
code	String	The code of the specified property.
value	Object	The value of the specified property.
expire_time	Long	The expiration time.
status	Integer	Indicates whether the specified property is pushed to the device status. Valid values: `0`: no `1`: yes
time	Long	The timestamp when the property was configured.

Request example

GET: /v2.0/cloud/thing/372817193*****/shadow/properties/desired

Return example

{
    "result": {
        "properties": [
            {
                "code": "switch_led",
                "dpId": 20,
                "expire_time": 1678427008528,
                "time": 1669797124390,
                "value": false,
                "status": 1
            }
        ]
    },
    "t": 1675393820827,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocSet Desired Property

Next DocQuery Things Data Model