El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.
- What's New
- Service Overview
- Getting Started
-
User Guide
- Management Platform
- Developer Center
-
Developer Guide
-
Product Development
- Obtaining Development Resources
- Creating a Project and Product
- Developing a Product Model
-
Developing a Codec
- Development Guide
- Offline Development
- Codec Development Examples
-
Reference
- Message Processing Flow
- decode API Description
- Description of encode API
- getManufacturerId Interface Description
- getModel Interface Description
- Precautions on Interface Implementation
- Input/Output Format of the Codec Plug-In
- Implementation Sample Interpretation
- Appendix: Encryption Algorithms Supported by the JDK
- Developing an Application
- Developing a Device
- Self-Service Testing
- Product Release
- Device Interconnection
- Application Interconnection
-
SDK Usage Guide on the Device Side
-
LiteOS SDK Integration Development Guide
- Overview
-
Processfor Connecting Devices to OceanConnect on the Device Side
- Preparations
- Entrypoint Function for LiteOS SDK Device-Cloud Interconnect Components
- Initializing LiteOS SDK Device-Cloud Interconnect Components
- Creating a Data Reporting Task
- Command Processing Function for LiteOS SDK Device-Cloud Interconnect Components
- Main Function Body for LiteOS SDK Device-Cloud Interconnect Components
- Data Structure
- Appendix 1 LWM2M
-
LiteOS SDK Integration Development Guide
-
SDK Usage Guide on the Application Side
-
Huawei IoT Platform Java SDK Usage Guide
- Before You Start
- Requirements for the Development Environment
- Downloading Related Development Resources
- Importing the Java SDK Demo
- Initializing and Configuring Certificates
- Calling Service APIs
- Implementing Callback APIs and Making, Exporting, and Uploading a Callback Certificate
- Service API Calling Process and Precautions
- Testing the SDK
-
Huawei IoT Platform Java SDK Usage Guide
-
Product Development
-
API Reference
-
Northbound API Reference
- Overview
- API Usage Statement
- Secure Application Access
- Device Management
- Data Collection
-
Subscription Management
- Subscribing to Service Data of the IoT Platform
- Subscribing to Management Data of the IoT Platform
- Querying a Subscription
- Querying Subscription in Batches
- Deleting a Subscription
- Deleting Subscriptions in Batches
-
Push Notification
- Pushing Device Registration Notifications
- Pushing Device Binding Notifications
- Pushing Device Information Change Notifications
- Pushing Device Data Change Notifications
- Pushing Batch Device Data Change Notifications
- Pushing Device Service Capability Change Notifications
- Pushing Device Service Capability Addition Notifications
- Pushing Device Service Capability Deletion Notifications
- Pushing Device Deletion Notifications
- Pushing Device Acknowledgment Notifications
- Pushing Device Command Response Notifications
- Pushing Command Status Change Notifications
- Pushing Rule Event Notifications
- Pushing Device Shadow Status Change Notifications
- Pushing Software Upgrade Status Change Notifications
- Pushing Software Upgrade Result Notifications
- Pushing Firmware Upgrade Status Change Notifications
- Pushing Firmware Upgrade Result Notifications
- Command Delivery
- Batch Processing
- Device Group Management
- Device Upgrade
-
Northbound Java SDK API Reference
- SDK Demo Architecture and Usage Guide
- SDK Initialization Configuration and Test
-
Service API List
- Secure Application Access
- Device Management
- Batch Processing
- Subscription Management
-
Message Push
- Pushing Device Registration Notifications
- Pushing Device Binding Notifications
- Pushing Device Information Change Notifications
- Pushing Device Data Change Notifications
- Pushing Batch Device Data Change Notifications
- Pushing Device Service Information Change Notifications
- Pushing Device Deletion Notifications
- Pushing Device Acknowledgment Notifications
- Pushing Device Command Response Notifications
- Pushing Device Event Notifications
- Pushing Device Model Addition Notifications
- Pushing Device Model Deletion Notifications
- Pushing Device Shadow Status Change Notifications
- Pushing Software Upgrade Status Change Notifications
- Pushing Software Upgrade Result Notifications
- Pushing Firmware Upgrade Status Change Notifications
- Pushing Firmware Upgrade Result Notifications
- Pushing NB-IoT Command Status Change Notifications
- Command Delivery (NB-IoT Commands)
- Command Delivery (Non-NB-IoT Commands)
- Data Collection
- Device Group Management
-
Device Upgrade
- Querying a Version Package List
- Querying a Specified Version Package
- Deleting a Specified Version Package
- Creating a Software Upgrade Task
- Creating a Firmware Upgrade Task
- Querying the Result of a Specified Upgrade Task
- Querying Details About Subtasks of a Specified Upgrade Task
- Querying an Upgrade Task List
-
Northbound PHP SDK API Reference
- SDK Demo Architecture and Usage Guide
- SDK Initialization Configuration and Test
-
Service API List
- Secure Application Access
- Device Management
- Batch Processing
- Subscription Management
-
Message Push
- Pushing Device Registration Notifications
- Pushing Device Binding Notifications
- Pushing Device Information Change Notifications
- Pushing Device Data Change Notifications
- Pushing Batch Device Data Change Notifications
- Pushing Device Service Information Change Notifications
- Pushing Device Deletion Notifications
- Pushing Device Acknowledgment Notifications
- Pushing Device Command Response Notifications
- Pushing Device Event Notifications
- Pushing Device Model Addition Notifications
- Pushing Device Model Deletion Notifications
- Pushing Device Shadow Status Change Notifications
- Pushing Software Upgrade Status Change Notifications
- Pushing Software Upgrade Result Notifications
- Pushing Firmware Upgrade Status Change Notifications
- Pushing Firmware Upgrade Result Notifications
- NB-IoT Device Command Status Change Notification
- Command Delivery (NB-IoT Commands)
- Command Delivery (Non-NB-IoT Commands)
- Data Collection
- Device Group Management
-
Device Upgrade
- Querying a Version Package List
- Querying a Specified Version Package
- Deleting a Specified Version Package
- Creating a Software Upgrade Task
- Creating a Firmware Upgrade Task
- Querying the Result of a Specified Upgrade Task
- Querying Details About Subtasks of a Specified Upgrade Task
- Querying an Upgrade Task List
-
Northbound Python SDK API Reference
- SDK Demo Architecture and Usage Guide
- SDK Initialization Configuration and Test
-
Service API List
- Secure Application Access
- Device Management
- Batch Processing
- Subscription Management
-
Message Push
- Pushing Device Registration Notifications
- Pushing Device Binding Notifications
- Pushing Device Information Change Notifications
- Pushing Device Data Change Notifications
- Pushing Batch Device Data Change Notifications
- Pushing Device Service Information Change Notifications
- Pushing Device Deletion Notifications
- Pushing Device Acknowledgment Notifications
- Pushing Device Command Response Notifications
- Pushing Device Event Notifications
- Pushing Device Model Addition Notifications
- Pushing Device Model Deletion Notifications
- Pushing Device Shadow Status Change Notifications
- Pushing Software Upgrade Status Change Notifications
- Pushing Software Upgrade Result Notifications
- Pushing Firmware Upgrade Status Change Notifications
- Pushing Firmware Upgrade Result Notifications
- NB-IoT Device Command Status Change Notification
- Command Delivery (NB-IoT Commands)
- Command Delivery (Non-NB-IoT Commands)
- Data Collection
- Device Group Management
-
Device Upgrade
- Querying a Version Package List
- Querying a Specified Version Package
- Deleting a Specified Version Package
- Creating a Software Upgrade Task
- Creating a Firmware Upgrade Task
- Querying the Result of a Specified Upgrade Task
- Querying Details About Subtasks of a Specified Upgrade Task
- Querying an Upgrade Task List
- AgentLite API Reference (Android)
-
AgentLite API Reference (C)
- Before You Start
- API Description
-
Common Data Structures
- ST_IOTA_DEVICE_INFO Structure
- IEs in EN_IOTA_BIND_IE_TYPE Messages
- Enumerated Values of the EN_IOTA_BIND_RESULT_TYPE Parameter
- IEs in EN_IOTA_LGN_IE_TYPE Messages
- Enumerated Values of the EN_IOTA_LGN_REASON_TYPE Parameter
- Enumerated Values of the EN_IOTA_CFG_TYPE Parameter
- IEs in EN_IOTA_HUB_IE_TYPE Messages
- Enumerated Values of the EN_IOTA_HUB_RESULT_TYPE Parameter
- IEs in EN_IOTA_DATATRANS_IE_TYPE Messages
- IEs in EN_IOTA_DEVUPDATE_IE_TYPE Messages
- Data Types
- AgentLite API Reference (Java)
- MQTT Interface Reference
-
Northbound API Reference
-
FAQs
- FAQs
- Specifications
- Product Use
-
Secondary Development
-
FAQs About Product Development
-
Profile Definition
- How to Develop a Profile
- Upload Is Unavailable When Uploading a Profile to the Developer Center
- Incorrect File Format Is Displayed When Uploading a Profile to the Developer Center
- Message Is Displayed Indicating That the Manufacturer ID and Device Model Exist When Uploading a Profile to the Developer Center
- How to Select a Data Type When Developing a Profile Online
- Profile Cannot Be Edited
-
Plug-In Development
- How to Develop Codecs
- Failed to Deploy a Plug-in That Is Developed Online
- What Is the Code Rule for Fields of the string and varstring Types
- What Is the Code Rule for Fields of the array and variant Types
- Whether Plug-Ins That Are Developed Online Support Transparent Transmission
- How to Use messageId During Online Codec Development
- How to Configure a Command Delivery Response During Online Codec Development
- Failed to Deploy a Plug-in That Is Developed Offline
- Failed to Upload a Plug-in That Is Developed Offline
- Plug-In Package Developed Offline Has Been Checked But Cannot Be Found When Uploading to the IoT Platform
- Codec Exception Occurs After a Plug-In Package Developed Offline That Has Been Checked Is Uploaded to the IoT Platform
- Offline Signature Fails
-
Device Development
- Registered Devices Cannot Connect to the IoT Platform
- Message 513 Is Reported When Devices Are Connected to the IoT Platform
- DTLS Encryption Algorithms Supported by the IoT Platform
- What Does CTNB Mean
- How to Select PSM, DRX, and eDRX
- Devices Cannot Receive Commands from the IoT Platform
- IoT Platform Does Not Receive Data Reported by Devices
- Historical Data Does Not Contain Data Reported By Devices While No Error Occurs
- Duration for Devices to Receive Commands
- Devices Fail to Receive Data Reporting Responses
- Data Reporting Is Successful at One Position But Fails at Another Position
- Command Status Is Not Changed to Successful After a Device Reports the Command Execution Result
- Whether the IoT Platform Can Switch Between the Big-Endian and Little-Endian
- Commands Fail to Be Delivered When a Device in DRX Mode Does Not Report Data in One to Two Days
-
Profile Definition
-
FAQs About Application Development
-
Calling APIs
- Authentication API of the IoT Platform Is Successfully Called Locally But Fails to Be Called on Application Servers
- Error Occurs When an NA Calls an API
- Online Application Simulator Fails to Deliver Commands
- Command Is Successfully Delivered Using the Simulator But Fails to Be Delivered by Calling the API
- Application Server Fails to Deliver Commands and Receives Error Code 403
- How Does an Application Server Deliver a Cache Command
- What Does an Expired Command Mean
- Does the IoT Platform Support Command Resending
- What Does a Timeout Command Mean
- Can the IoT Platform Deliver Commands in Batches
- Are the APIs of the IoT Platform Called Only Using Java
- What Are the Command States on the IoT Platform
- Failed to Call the Calling the Registering Directly Connected Devices API
- APIs Fail To Be Called After a Period of Time While Parameters Remain Unchanged
- Commands Fail to Be Sent After a Period of Time While the Previous Commands Are Successfully Sent
- Historical Data Is Not Returned When the Querying Historical Device Data API Is Called
- Devices Registered with the IoT Platform Are Deleted After a Period of Time
-
Subscription and Push
- Invalid Callback Address Occurs When Calling the Subscription API
- How to Obtain the subscriptionId When Calling the Querying Subscription in Batches API
- Application Server Fails to Receive Data Pushed by the IoT Platform
- How Do I Export the HTTPS Push Certificate
- Difference Between deviceDatachanged and deviceDataschanged
- How Does an Application Server Obtain the IMEI of Devices
- Application Server Receives Data But an Error Is Displayed on the IoT Platform
- Push Messages May Fail to Be Sent to Application Servers
- How Does an Application Servers Obtain The Address Used by the IoT Platform to Push Messages
- Does the IoT Platform Supports Re-push
- How Does an Application Server Receive a Command Status Change Notification
- Application Servers That Have Subscribed to Confirmation Notifications and Command Response Notifications Fail to Receive Push Messages
- Does the IoT Platform Support Only HTTPS Callback Addresses
- Can the IoT Platform Push Data Reported by Different Devices Under the Same Application to Two Servers
- Can a Subscription Address Be a Domain Name
- Can a Callback Address Be Changed
- How Do I Obtain the Callback URL When Calling the Subscription API
-
Calling APIs
-
FAQs About Software/Firmware Upgrade
- What Is Software/Firmware Upgrade
- Can IoT Platform Download Software/Firmware Packages From Third-party Servers
- Can the Target Version Be Earlier Than the Source Version?
- How Do I Obtain Software/Firmware Packages and Their Version Numbers
- Software/Firmware Upgrade Task Is Ended Immediately After Being Created
- What Is the Source Version Required for Uploading a Firmware Package on the Management Portal
- When Reporting Data, Devices Receive the Software/Firmware Version Query Command from the IoT Platform
- Are Services Interrupted During the Software/Firmware Upgrade
- What Are Common Software/Firmware Upgrade Errors
- Retry When Some Devices in the Group Failed to Be Upgraded
- Is Resumable Transmission Supported When the IoT Platform Sends Software/Firmware Packages to Devices
-
Others
- Does the IoT Platform Support Device Registration in Batches
- Does the IoT Platform Perform Flow Control on Applications and Devices
- How Does an Application Server Obtain Data Reported by Devices to the IoT Platform
- Is the Maximum Number of Applications and Devices Restricted on the IoT Platform
- Why Is an Online Device Changed to an Abnormal or Offline State After a Period of Time
- Are Command Delivery and Data Reporting Successful After a Device Becomes Abnormal or Offline
- How Long Does a Device Receive an Immediately-Delivered Command in eDRX Mode
- How Long Is Data Stored on the IoT Platform
- Can Multiple Devices Use One IMEI
-
FAQs About Product Development
- General Reference
Copied.
Creating a Software Upgrade Task
Typical Scenario
If the device software needs to be upgraded, an NA can call this API to create a software upgrade task for multiple devices. Before the upgrade, ensure that the target version package has been uploaded to the IoT platform. Currently, only the software of NB-IoT devices can be upgraded.
API Function
This API is used by an NA to upgrade the software of multiple devices on the IoT platform. Currently, only the software of NB-IoT devices can be upgraded.
API Description
1 |
def createSoftwareUpgradeTask(self, cutInDTO, accessToken) |
Parameter Description
|
Parameter |
Mandatory or Optional |
Type |
Location |
Description |
|---|---|---|---|---|
|
cutInDTO |
Mandatory |
CreateUpgradeTaskInDTO |
body |
For details, see CreateUpgradeTaskInDTO structure. |
|
accessToken |
Mandatory |
String |
header |
This parameter is set to the value of the access token obtained by calling the Authentication API. |
CreateUpgradeTaskInDTO structure
|
Parameter |
Mandatory or Optional |
Type |
Location |
Description |
|---|---|---|---|---|
|
fileId |
Mandatory |
String |
body |
Identifies the target firmware version. |
|
targets |
Mandatory |
OperateDevices |
body |
Indicates the devices to be upgraded. For details, see OperateDevices structure. |
|
policy |
Optional |
OperatePolicy |
body |
Indicates the execution policy of an upgrade task. For details, see OperatePolicy structure. |
|
Parameter |
Mandatory or Optional |
Type |
Location |
Description |
|---|---|---|---|---|
|
deviceGroups |
Optional |
List<String> |
body |
Indicates the device group name list. A maximum of 256 device groups are supported. Either this parameter or devices must be specified. |
|
deviceType |
Optional |
String |
body |
Specifies the type of a device. This parameter must be specified when a device group is specified. |
|
model |
Optional |
String |
body |
Indicates the device model. This parameter must be specified when a device group is specified. |
|
manufacturerName |
Optional |
String |
body |
Indicates the manufacturer name. This parameter must be specified when a device group is specified. |
|
devices |
Optional |
List<String> |
body |
Indicates the device ID list. A maximum of 256 devices are supported. Either this parameter or deviceGroups must be specified. |
|
Parameter |
Mandatory or Optional |
Type |
Location |
Description |
|---|---|---|---|---|
|
executeType |
Mandatory |
String |
body |
Indicates the execution type. The default value is now.
|
|
startTime |
Optional |
String |
body |
Indicates the start time of the operation task. This parameter must be specified when executeType is set to custom. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z. |
|
endTime |
Optional |
String |
body |
Indicates the end time of the operation task. This parameter must be specified when executeType is set to custom. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z. |
|
retryType |
Optional |
Boolean |
body |
Indicates whether the platform retries the task upon an execution failure. The default value is false.
|
|
retryTimes |
Optional |
Integer |
body |
Indicates the number of retries. The value ranges from 1 to 5. This parameter must be specified when retryType is set to true. |
Response Parameters
CreateUpgradeTaskOutDTO structure
|
Parameter |
Type |
Description |
|---|---|---|
|
operationId |
String |
Identifies an operation task. |
Error Codes
|
HTTP Status Code |
Error Code |
Error Description |
Remarks |
|---|---|---|---|
|
400 |
120015 |
Bad request error. |
A request error occurs. Recommended handling: Check whether the parameters in the request are correct. |
|
400 |
123016 |
The parameter is error, targetversion not match with device. |
The value of targetVersion is incorrect. Specifically, it does not match the specified device. Recommended handling: Check whether the values of deviceType, manufacturerName, and model carried in the API request are consistent with the target version package information specified by fileId. |
|
400 |
123019 |
manufacturerName is null. |
The manufacturer name is null. Recommended handling: Check whether manufacturerName carried in the API request is correct. |
|
400 |
123020 |
deviceType is null |
The device type is null. Recommended handling: Check whether deviceType carried in the API request is correct. |
|
400 |
123021 |
model is null. |
The device model is null. Recommended handling: Check whether model carried in the API request is correct. |
|
400 |
123022 |
deviceGroups and devices cannot be null together |
deviceGroups and devices cannot be both null. Recommended handling: Specify either deviceGroups or devices. |
|
400 |
123023 |
deviceGroups and devices cannot be exist together |
deviceGroups and devices cannot coexist. Recommended handling: Specify either deviceGroups or devices. |
|
400 |
123024 |
The number of deviceGroups or devices reached upper limit |
The number of device groups or devices reaches the upper limit. Recommended handling: Check the number of device groups or devices. The number cannot exceed 256. |
|
400 |
123025 |
executeType is error or can not to be null. |
The value of executeType is incorrect or is not specified. Recommended handling: Check whether executeType in the request is unspecified or incorrect. |
|
400 |
123026 |
startTime or endTime is null or error. |
The value of startTime or endTime is empty or incorrect. Recommended handling: Check whether startTime and endTime in the request are unspecified or incorrect. |
|
400 |
123028 |
retryTimes is null or beyond the limit. |
The value of retryTimes is empty or exceeds the upper limit. Recommended handling: Verify that the value of retryTimes in the request is left unspecified or is not less than 1 or greater than 5. |
|
400 |
123032 |
startTime can not be later than the endTime. |
The value of startTime cannot be later than the value of endTime. Recommended handling: Check whether startTime in the request is later than endTime. |
|
400 |
123033 |
startTime can not be earlier than the now. |
The value of startTime cannot be earlier than the current time. Recommended handling: Check whether startTime in the request is earlier than the current time. |
|
400 |
123034 |
endtime must be greater than 5 minutes. |
The value of endtime must be 5 minutes later than that of startTime. Handling suggestions: Verify that the interval between startTime and endTime in the request is greater than 5 minutes. |
|
403 |
1010009 |
app throttle exceed. |
The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency. |
|
403 |
1010005 |
App_key or access_token is invalid. |
The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct. |
|
404 |
123002 |
Device or package file not found. |
The device or package does not exist. Recommended handling: Check whether fileId carried in the API request is correct. |
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
