查询期望属性

更新时间：2023-12-07 03:33:50

本文介绍查询期望属性的 API。

接口描述

根据设备 ID，查询指定设备的期望属性信息。如果设置的时间已过期，返回结果为空。

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
device_id	String	uri	true	设备 ID。
codes	String	query	false	属性 code 集合，以逗号分隔。

返回参数

参数名	类型	说明
result	Object	返回结果。

result 说明

参数名	类型	说明
properties	List	期望属性列表。

properties 说明

参数名	类型	说明
dpId	Integer	属性 ID。
code	String	属性 code。
value	Object	属性值。
expire_time	Long	过期时间。

请求示例

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

返回示例

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

错误码

参考错误码。