希沃物联平台文档

查询设备快照

此接口用于查询设备快照信息。

1 接口路径

GET /api/v1/device/shadow/{deviceId}

2 请求参数

路径参数：

名称 类型 是否必需 描述
deviceId BigInteger 是 设备ID

3 返回参数

统一返回参数说明参考：公共参数，以下是返回业务参数（data）的说明：

名称 类型 描述
state Object 属性状态，参考返回示例
metadata Object 属性元数据，参考返回示例

4 返回状态码

公共状态码说明参考：公共参数，以下是业务关联的状态码说明：

5 示例

请求示例

/api/v1/device/shadow/297160167601094656

返回示例

{
    "code": "000000",
    "data": {
        "metadata": {
            "desired": {
                "color": {
                    "version": 1546914665389
                }
            },
            "reported": {
                "volume": {
                    "version": 1545183822011
                }
            }
        },
        "state": {
            "desired": {
                "color": "value"
            },
            "reported": {
                "volume": "10"
            }
        }
    },
    "message": "success"
}