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
Koo Command Line Interface
Updated at: Feb 24, 2022 GMT+08:00

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

The NA must return a response code after receiving a message pushed by the IoT platform.

API Prototype

Method

POST

URL

The URL is determined by callbackUrl in the subscription request sent by the NA.

Transport Protocol

HTTPS/HTTP

Request Parameters

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is swUpgradeResultNotify.

deviceId

Mandatory

String

body

Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.

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.

curVersion

Mandatory

String

body

Indicates the current software version of the device.

targetVersion

Mandatory

String

body

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

sourceVersion

Mandatory

String

body

Indicates the source software version of the device.

swUpgradeResult

Mandatory

String

body

Indicates the software upgrade result.

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

upgradeTime

Mandatory

String

body

Indicates the upgrade time.

resultDesc

Mandatory

String

body

Indicates the upgrade result description.

errorCode

Mandatory

String

body

Indicates a status error code reported by the device.

description

Mandatory

String

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": "***"
}

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