IoTIoT

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain Service
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
HCloud CLI
Help Center> IoT> API Reference> Northbound PHP SDK API Reference> Service API List> Message Push> Pushing Firmware Upgrade Result Notifications
Updated at: Feb 24, 2022 GMT+08:00

Pushing Firmware Upgrade Result Notifications

Typical Scenario

After an NA subscribes to firmware upgrade result change notifications (the notification type is fwUpgradeResultNotify) on the IoT platform, the IoT platform sends a notification message to the NA when a firmware upgrade task is complete.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to firmware upgrade result notifications.

Note

  1. When Subscribing to Management Data of the IoT Platform, an NA must subscribe to the specified callback address in the API description. The server and port in the callback address are the public IP address and specified port of the NA.
  2. An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
  3. If the callback address is not the address of the NA, the NA must implement the original callback API. For details on the API content, see Message Push in the Huawei IoT Platform Northbound API Reference.

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver

Callback API

function handleFwUpgradeResult(NotifyFwUpgradeResultDTO $body)

Class

PushMessageReceiver

Parameter Description

NotifyFwUpgradeResultDTO structure

Parameter

Mandatory or Optional

Location

Description

$notifyType

Mandatory

body

Indicates the notification type. The value is fwUpgradeResultNotify.

$deviceId

Mandatory

body

Identifies a device.

$appId

Mandatory

body

Identifies the application to which the device belongs.

$operationId

Mandatory

body

Identifies a firmware upgrade task.

$subOperationId

Mandatory

body

Identifies a firmware upgrade sub-task.

$curVersion

Mandatory

body

Indicates the current firmware version of the device.

$targetVersion

Mandatory

body

Indicates the target firmware version to which the device is to be upgraded.

$sourceVersion

Mandatory

body

Indicates the source firmware version of the device.

$Status

Mandatory

body

Indicates the upgrade result.

  • SUCCESS
  • FAIL

$statusDesc

Mandatory

body

Indicates the upgrade result description.

  • SUCCESS: The device upgrade is successful.
  • FAIL: The device upgrade fails.

$upgradeTime

Mandatory

body

Indicates the firmware upgrade duration.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"fwUpgradeResultNotify",
    "deviceId":"******",
    "appId":"***********",
    "operationId":"***********",
    "subOperationId":"***********",
    "curVersion":"1.6",
    "targetVersion":"1.6",
    "sourceVersion":"1.3",
    "status":"SUCCESS",
    "statusDesc":"****",
    "upgradeTime":"****"
}

Response Example

Response:
Status Code: 200 OK

Did you find this page helpful?

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel