Subscribing to Management Data of the IoT Platform

Typical Scenario

An NA can subscribe to management data of a device on the IoT platform. When operations are performed on the device (for example, device upgrade), the IoT platform notifies the NA of the operation status or results. The NA can call this API to subscribe to different types of device upgrade notifications on the IoT platform.

API Function

This API is used by an NA to subscribe to device upgrade notifications on the IoT platform. When the device is upgraded, the IoT platform sends a notification to the NA.

API Description

1	void subDeviceData(SubDeviceManagementDataInDTO smdInDTO, String accessToken)

Parameter Description

Parameter	Mandatory or Optional	Type	Location	Description
smdInDTO	Mandatory	SubDeviceManagementDataInDTO structure	body	For details, see SubDeviceManagementDataInDTO structure.
accessToken	Mandatory	String	header	If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API.

SubDeviceManagementDataInDTO structure

Parameter	Mandatory or Optional	Type	Location	Description
notifyType	Mandatory	String	body	Indicates the notification type. swUpgradeStateChangeNotify: software upgrade status change notification; sending such a notification after subscription swUpgradeResultNotify: software upgrade result notification; sending such a notification after subscription fwUpgradeStateChangeNotify: hardware upgrade status change notification; sending such a notification after subscription fwUpgradeResultNotify: hardware upgrade result notification; sending such a notification after subscription
callbackurl	Mandatory	String	body	Indicates the callback URL of a subscription, which is used to receive notification messages of the corresponding type. This URL must be an HTTPS channel callback URL and contain its port number. An example value is https://XXX.XXX.XXX.XXX:443/callbackurltest. NOTE: The HTTP channel can be used only for commissioning.

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type.

swUpgradeStateChangeNotify: software upgrade status change notification; sending such a notification after subscription
swUpgradeResultNotify: software upgrade result notification; sending such a notification after subscription
fwUpgradeStateChangeNotify: hardware upgrade status change notification; sending such a notification after subscription
fwUpgradeResultNotify: hardware upgrade result notification; sending such a notification after subscription

callbackurl

Mandatory

String

body

Indicates the callback URL of a subscription, which is used to receive notification messages of the corresponding type.

This URL must be an HTTPS channel callback URL and contain its port number. An example value is https://XXX.XXX.XXX.XXX:443/callbackurltest.

NOTE:

The HTTP channel can be used only for commissioning.

Response Parameters

void

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
400	100222	Internal server error.	The callback URL is invalid. Recommended handling: Check whether the callback URL in the request body is correct.
400	100228	The application input is invalid.	The application input is invalid. Recommended handling: Check whether parameters in the API request are correct by referring to the request parameter description.
403	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
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.
500	100229	Get AppKey from header failed.	Failed to obtain the AppKey from the message header.
500	100244	register out route fail.	Failed to register the route. Recommendation: Contact the IoT platform maintenance personnel.