Pushing Software Upgrade Status Change Notifications

Typical Scenario

After an NA subscribes to software upgrade status change notifications (the notification type is swUpgradeStateChangeNotify) on the IoT platform, the IoT platform sends a notification message to the NA when the software upgrade status changes.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to software upgrade status change 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 server.
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	def handleSwUpgradeStateChanged(self)
Class	PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter	Mandatory or Optional	Type	Location	Description
nsuscDTO	Mandatory	NotifySwUpgradeStateChangedDTO	body	For details, see NotifySwUpgradeStateChangedDTO structure.

NotifySwUpgradeStateChangedDTO structure

Parameter	Mandatory or Optional	Type	Location	Description
notifyType	Mandatory	String	body	Indicates the notification type. The value is swUpgradeStateChangeNotify.
deviceId	Mandatory	String	body	Uniquely identifies a device.
appId	Mandatory	String	body	Identifies the application to which the device belongs.
operationId	Mandatory	String	body	Identifies a software upgrade task.
subOperationId	Mandatory	String	body	Identifies a software upgrade sub-task.
swUpgradeState	Mandatory	String	body	Indicates the software upgrade status. downloading: The device is downloading the software package. downloaded: The device has finished downloading the software package. updating: The device is being upgraded. idle: The device is in the idle state.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"swUpgradeStateChangeNotify",
    "deviceId":"******",
    "appId":"***********",
    "operationId":"***********",
    "subOperationId":"***********",
    "swUpgradeState":"downloading"
}