Query Properties

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

Based on the device ID, query the property status reported by the device to the cloud.

API address

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

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 properties.

Description of properties

Parameter name	Type	Description
code	String	The code of the specified property.
time	Long	The timestamp when the property value was updated.
value	Object	The value of the specified property.
custom_name	String	The custom name.
dp_id	Integer	The ID of the specified property.

Request example

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

Return example

{
    "result": {
        "properties": [
            {
                "code": "switch_led",
                "custom_name": "cole_red",
                "dp_id": 20,
                "time": 1669797124390,
                "value": true
            }
        ]
    },
    "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 DocSend Property

Next DocModify Properties