Pushing Software Upgrade Result Notifications

Typical Scenario

After an NA subscribes to software upgrade result change notifications (the notification type is swUpgradeResultNotify) on the IoT platform, the IoT platform sends a notification message to the NA when a software 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 software upgrade result notifications.

Note

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.
An NA receives the content of a push message by inheriting the PushMessageReceiver class and rewriting the callback API.
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 handleSwUpgradeResult(NotifySwUpgradeResultDTO $body)
Class	PushMessageReceiver

Parameter Description

NotifySwUpgradeResultDTO structure

Parameter	Mandatory or Optional	Location	Description
$notifyType	Mandatory	body	Indicates the notification type. The value is swUpgradeResultNotify.
$deviceId	Mandatory	body	Identifies a device.
$appId	Mandatory	body	Identifies the application to which the device belongs.
$operationId	Mandatory	body	Identifies a software upgrade task.
$subOperationId	Mandatory	body	Identifies a software upgrade sub-task.
$curVersion	Mandatory	body	Indicates the current software version of the device.
$targetVersion	Mandatory	body	Indicates the target software version to which the device is to be upgraded.
$sourceVersion	Mandatory	body	Indicates the source software version of the device.
$swUpgradeResult	Mandatory	body	Indicates the software upgrade result. SUCCESS: The device upgrade is successful. FAIL: The device upgrade fails.
$upgradeTime	Mandatory	body	Indicates the upgrade time.
$resultDesc	Mandatory	body	Indicates the upgrade result description.
$errorCode	Mandatory	body	Indicates a status error code reported by the device.
$description	Mandatory	body	Indicates the description of the cause of error.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
Request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"swUpgradeResultNotify",
    "deviceId":"******",
    "appId":"***********",
    "operationId":"***********",
    "subOperationId":"***********",
    "curVersion":"1.3",
    "targetVersion":"1.5",
    "sourceVersion":"1.0",
    "swUpgradeResult":"SUCCESS",
    "upgradeTime":"***",
    "resultDesc":"***",
    "errorCode":"***",
    "description":"***"
}