Esta página ainda não está disponível no idioma selecionado. Estamos trabalhando para adicionar mais opções de idiomas. Agradecemos sua compreensão.
- What's New
- Product Bulletin
- Service Overview
- Billing
-
Getting Started
-
Quick Device Access - Property Reporting and Command Receiving
- Subscribing to IoTDA
- Connecting a Smart Smoke Detector to the Platform (Quick Usage)
- Registering a Simulated Smart Street Light Device
- Using MQTT.fx to Simulate Communication Between the Smart Street Light and the Platform
- Using a Virtual Smart Street Light to Communicate with the Platform (Java SDK)
- Using a Virtual Smart Street Light to Communicate with the Platform (C SDK)
- Quick Device Access - Message Sending and Receiving
- Quick Application Access
-
Quick Device Access - Property Reporting and Command Receiving
-
User Guide
- Overview
- IoTDA Instances
- Resource Spaces
- Device Access
- Message Communications
- Device Management
-
Rules
- Overview
- Data Forwarding Process
- SQL Statements
- Connectivity Tests
- Data Forwarding to Huawei Cloud Services
- Data Forwarding to Third-Party Applications
- Data Forwarding Channel Details
- Data Forwarding Stack Policies
- Data Forwarding Flow Control Policies
- Abnormal Data Target
- Device Linkage
- Monitoring and O&M
- Granting Permissions Using IAM
-
Best Practices
- Introduction
-
Device Access
- Developing an MQTT-based Simulated Smart Street Light Online
- Developing a Smart Street Light Using NB-IoT BearPi
- Developing a Smart Smoke Detector Using NB-IoT BearPi
- Connecting and Debugging an NB-IoT Smart Street Light Using a Simulator
- Developing a Protocol Conversion Gateway for Access of Generic-Protocol Devices
- Connecting a Device That Uses the X.509 Certificate Based on MQTT.fx
- Connecting to IoTDA Based on the BearPi-HM_Nano Development Board and OpenHarmony 3.0
- Testing MQTT Performance Using JMeter
- Device Management
- Data Forwarding
- Device Linkage
-
Developer Guide
- Before You Start
- Obtaining Resources
- Product Development
- Development on the Device Side
- Development on the Application Side
-
API Reference
-
API Reference on the Application Side
- Before You Start
- Calling APIs
- API Overview
-
API
- Product Management
- Device Management
- Device Message
- Device Command APIs
- Device Property
- AMQP Queue Management
- Access Credential Management
- Data Forwarding Rule Management
-
Transition Data
- Push a Device Status Change Notification
- Push a Device Property Reporting Notification
- Push a Device Message Status Change Notification
- Push a Batch Task Status Change Notification
- Push a Device Message Reporting Notification
- Push a Device Addition Notification
- Push a Device Update Notification
- Push a Device Deletion Notification
- Push a Product Addition Notification
- Push a Product Update Notification
- Push a Product Deletion Notification
- Push an Asynchronous Device Command Status Change Notification
- Rule Management
- Device Shadow
- Group Management
- Tag Management
- Instance Management
- Resource Space Management
- Batch Task
- Device CA Certificate Management
- OTA Upgrade Package Management
- Message Broadcasting
- Device Tunnel Management
- Stack policy management
- Flow control policy management
- Device Proxy
- Device Policy Management
- Bridge Management
- Pre-provisioning Template Management
- Custom Authentication
- Codec Function Management
- Permissions and Supported Actions
- Examples
- Appendix
-
MQTT or MQTTS API Reference on the Device Side
- Before You Start
- Communication Modes
- Topics
- Device Connection Authentication
- Device Commands
- Device Messages
- Device Properties
-
Gateway and Child Device Management
- Platform Notifying a Gateway of New Child Device Connection
- Platform Notifying a Gateway of Child Device Deletion
- Gateway Synchronizing Child Device Information
- Gateway Updating Child Device Status
- Responding to a Request for Updating Child Device Statuses
- Gateway Requesting for Adding Child Devices
- Platform Responding to a Request for Adding Child Devices
- Gateway Requesting for Deleting Child Devices
- Platform Responding to a Request for Deleting Child Devices
- Software and Firmware Upgrade
- File Upload and Download
- Device Time Synchronization
- Device Reporting Information
- Device Log Collection
- Remote Configuration
- Device Tunnel Management
- HTTPS API Reference on the Device Side
- LwM2M API Reference on the Device Side
- Security Tunnel WebSocket API Reference
- Module AT Command Reference
- Change History
-
API Reference on the Application Side
- SDK Reference
-
FAQs
- Top FAQs
-
Solution Consulting
- In What Scenarios Can the IoT Platform Be Applied?
- What Are the Changes Brought by the Integration of IoT Device Management and IoTDA?
- Can I Enable IoTDA for IAM Users or Sub-Projects?
- Which Regions of Huawei Cloud Are Supported by the IoT Platform?
- Does Huawei Provide Modules, Hardware Devices, and Application Software?
- What Should I Do If I Want to Call an API But Have No Permissions to Do So as an IAM User? (Is It Edition-specific?)
- Why Was I Prompted to Grant Security Administrator Permissions When I Create a Rule or Set Resource File Storage?
- Which Resource Space Will Be Set As Default on the IoT Platform?
- How Does IoTDA Obtain Device Data?
- Is There Any Limitation on the Number of Resource Spaces and Devices I Can Add on the IoT Platform?
- Does the IoTDA Support Device Registration in Batches?
- Are There Any Limitations on the Use of the IoT Platform?
- What DTLS Encryption Algorithms Are Supported by the IoT Platform?
- Does the IoT Platform Support Conversion Between Big-Endian and Little-Endian for Binary Data?
- What Is NB-IoT?
- What Are the Components of the IoT Platform and What Hardware Architectures Does It Support?
- How Do I Obtain the Platform Access Address?
- Device Integration
- IoT Device SDKs
- LwM2M/CoAP Device Access
- MQTT-based Device Access
- Products Models
- Message Communications
- Subscription and Push
- Codecs
- OTA Upgrades
- Application Integration
- General Reference
Copied.
Device Obtaining Device Shadow Data from the Platform
Function
This API is used by a device to obtain device shadow data from IoTDA. You can configure desired data in a device shadow through an application or the platform. When a device goes online and subscribes to this topic, the device can obtain the device shadow data from the platform and synchronize the desired device properties.
The interaction logic is described as follows:
1. The application calls the API for configuring desired properties in a device shadow or configures the device shadow data on the console.
2. The device (which has subscribed to the corresponding topic) proactively sends a request to obtain the device shadow data from the platform.
3. The platform responds to the device request and returns the device shadow data.
4. The device parses the desired properties and modifies device properties.
Topic
Upstream: $oc/devices/{device_id}/sys/shadow/get/request_id={request_id}
Downstream: $oc/devices/{device_id}/sys/shadow/get/response/request_id={request_id}
NOTE:
- {request_id} is used to uniquely identify a request. If this parameter is carried in a message sent by a device, ensure that the parameter value is unique on the device by using an incremental number or UUID.
- The upstream request parameters on the device side carry the unique ID, which is carried in request_id in the downstream topic to identify the unique request chain.
- When subscribing to a downstream topic, you are advised to use the wildcard character # to replace request_id={request_id}, that is, $oc/devices/{device_id}/sys/shadow/get/response/#.
Upstream Request Parameters
|
Parameter |
Mandatory/Optional |
Type |
Description |
|---|---|---|---|
|
object_device_id |
Optional |
String |
Explanation: ID of the device that requests its device shadow. |
|
service_id |
Optional |
String |
Explanation: ID of a service of the device that requests the device shadow. If this parameter is not specified, device shadow data of all services will be returned. |
Downstream Response Parameters
|
Parameter |
Mandatory/Optional |
Type |
Description |
|---|---|---|---|
|
object_device_id |
Mandatory |
String |
Explanation: ID of the device that requests its device shadow. |
|
shadow |
Optional |
List<ShadowData> |
Explanation: Indicates the shadow data. |
ShadowData structure
|
Parameter |
Mandatory/Optional |
Type |
Description |
|---|---|---|---|
|
service_id |
Mandatory |
String |
Explanation: Service ID of the device, which is determined by the product model. |
|
desired |
Optional |
PropertiesData |
Explanation: Indicates the property list in the desired section of the device shadow. |
|
reported |
Optional |
PropertiesData |
Explanation: Indicates the property list in the reported section of the device shadow. |
|
version |
Optional |
Integer |
Explanation: Device shadow version. |
PropertiesData structure
|
Parameter |
Mandatory/Optional |
Type |
Description |
|---|---|---|---|
|
properties |
Mandatory |
Object |
Explanation: Indicates the property list of the device service. Multiple property parameters can be defined in the product model associated with the device. |
|
event_time |
Optional |
String |
Explanation: Indicates the UTC time of the device property data. The format is yyyyMMdd'T'HHmmss'Z', for example, 20161219T114920Z. |
Example Upstream Request
Topic: $oc/devices/{device_id}/sys/shadow/get/request_id={request_id}
Data format:
{
"object_device_id": "40fe3542-f4cc-4b6a-98c3-61a49ba1acd4",
"service_id": "WaterMeter"
}
Example Downstream Response
Topic: $oc/devices/{device_id}/sys/shadow/get/response/request_id={request_id}
Data format:
{
"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
}
]
}
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
