- 最新动态
- 功能总览
- 服务公告
- 计费说明
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- 开发指南
-
API参考
- 应用侧API参考
- 设备侧MQTT/MQTTS接口参考
- 设备侧HTTPS接口参考
- 设备侧LwM2M接口参考
- 安全隧道WebSocket接口参考
- 模组AT指令参考
- 修订记录
- SDK参考
- 场景代码示例
-
常见问题
- 热门问题
-
方案咨询
- 连接IoT平台的业务场景有哪些？
- 设备管理服务和设备接入服务合一后的差异点是什么？
- IAM子用户或子项目是否可以开通物联网平台服务？
- 物联网平台支持在华为云的哪些区域开通？
- 华为是否提供模组/硬件终端/应用软件等？
- IAM用户访问API提示没有权限？(是否区分版本？)
- 创建规则或者设置资源文件存储时候提示赋予Security Administrator权限
- 物联网平台设置默认资源空间的规则是什么？
- 设备接入服务如何获取设备数据？
- 物联网平台的资源空间和设备可以无限创建吗？
- 物联网平台支持批量注册设备吗？
- 物联网平台对应用侧和设备侧在开发或使用时有限制吗？
- 物联网平台支持的DTLS加密算法有哪些？
- 物联网平台支持二进制大小端模式切换吗？
- 什么是NB-IoT？
- 物联网平台支持的硬件架构和使用的相关组件有哪些？
- 如何获取平台接入地址？
- 设备集成相关问题
- 设备侧SDK相关问题
- 设备发放相关问题
- LWM2M/CoAP接入相关问题
- MQTT接入相关问题
- 泛协议接入相关问题
- 物模型相关问题
- 消息通信相关问题
- 订阅推送相关问题
- 编解码插件相关问题
- OTA升级相关问题
- 应用集成相关问题
- 实例管理相关问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
设备侧获取平台的设备影子数据
功能介绍
用于设备向平台获取设备影子数据。用户可以通过应用服务器或物联网控制台配置设备影子预期数据，设备上线时订阅该topic，可以获取到平台设备影子数据，以此来同步设备属性期望值，从而完成设备属性值的修改。
简单交互逻辑介绍如下：
① 应用调用“配置设备影子预期数据”接口或在控制台配置设备影子数据；
② 设备侧（已完成关联Topic订阅）主动上报请求，获取平台的设备影子数据；
③ 平台响应设备请求，返回设备影子数据；
④ 设备侧解析属性期望值，并完成设备属性值修改。
Topic
上行: $oc/devices/{device_id}/sys/shadow/get/request_id={request_id}
下行: $oc/devices/{device_id}/sys/shadow/get/response/request_id={request_id}
说明：
- {request_id}用于唯一标识这次请求。设备侧发起的消息带该参数时，需要保证设备侧该参数值的唯一性，可以用递增的数字或者UUID来实现。
- 设备侧上行请求参数中携带唯一标识，该唯一标识会在下行topic中request_id携带给设备以标记唯一请求链。
- 订阅下行Topic时建议使用通配符“#”来替代“request_id={request_id}”即为：$oc/devices/{device_id}/sys/shadow/get/response/#。
上行请求参数说明
|
字段名 |
必选/可选 |
类型 |
参数描述 |
|---|---|---|---|
|
object_device_id |
可选 |
String |
参数解释： 需要获取设备影子的目标设备ID。 |
|
service_id |
可选 |
String |
参数解释： 需要获取设备影子的设备服务ID，不带的话查询所有服务ID的设备影子数据。 |
下行响应参数说明
|
字段名 |
必选/可选 |
类型 |
参数描述 |
|---|---|---|---|
|
object_device_id |
必选 |
String |
参数解释： 设备影子的目标设备ID。 |
|
shadow |
可选 |
List<ShadowData> |
参数解释： 服务影子数据。 |
ShadowData结构定义：
|
字段名 |
必选/可选 |
类型 |
参数描述 |
|---|---|---|---|
|
service_id |
必选 |
String |
参数解释： 设备的服务ID，由创建的产品模型确定。 |
|
desired |
可选 |
PropertiesData |
参数解释： 设备影子desired区的属性列表。 |
|
reported |
可选 |
PropertiesData |
参数解释： 设备影子reported区的属性列表。 |
|
version |
可选 |
Integer |
参数解释： 设备影子版本信息。 |
PropertiesData结构定义：
|
字段名 |
必选/可选 |
类型 |
参数描述 |
|---|---|---|---|
|
properties |
必选 |
Object |
参数解释： 设备服务的属性列表，具体字段在设备关联的产品模型里定义，可以设置多个字段。 |
|
event_time |
可选 |
String |
参数解释： 设备属性数据的UTC时间（格式：yyyyMMdd'T'HHmmss'Z'），如：20161219T114920Z。 |
上行请求示例
Topic: $oc/devices/{device_id}/sys/shadow/get/request_id={request_id}
数据格式：
{
"object_device_id": "40fe3542-f4cc-4b6a-98c3-61a49ba1acd4",
"service_id": "WaterMeter"
}
下行响应示例
Topic：$oc/devices/{device_id}/sys/shadow/get/response/request_id={request_id}
数据格式：
{
"object_device_id": "40fe3542-f4cc-4b6a-98c3-61a49ba1acd4",
"shadow": [
{
"service_id": "WaterMeter",
"desired": {
"properties": {
"temperature": "60"
},
"event_time": "20151212T121212Z"
},
"reported": {
"properties": {
"temperature": "60"
},
"event_time": "20151212T121212Z"
},
"version": 1
}
]
}
