Querying Device Activation Status
Typical Scenario
After an application registers a device on the platform, the activation status of the device is false before the device connects to the platform for the first time. When the device connects to the platform for the first time, the activation status of the device is true regardless of whether the device is online, offline, or abnormal. The application can call this API to query the activation status of the device to check whether the device has connected to the platform.
API Function
This API is used by an application to query the activation status of a device on the platform to determine whether the device has connected to the platform.
API Description
1 | QueryDeviceStatusOutDTO queryDeviceStatus(String deviceId, String appId, String accessToken) throws NorthApiException
|
Class
DeviceManagement
Parameter Description
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| deviceId | Mandatory | String | path | Identifies a device. The device ID is allocated by the platform during device registration. |
| appId | Mandatory | String | query | If the device belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application. |
| 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. |
Return Value
QueryDeviceStatusOutDTO
| Parameter | Type | Description |
|---|---|---|
| deviceId | String(256) | Identifies a device. |
| activated | Boolean | Indicates whether the device is activated.
|
| name | String(256) | Indicates the name of the device. |
Error Codes
| HTTP Status Code | Error Code | Error Description | Remarks |
|---|---|---|---|
| 403 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 403 | 100217 | The application has not been authorized. | The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null. |
| 403 | 1010009 | The application calls the API at a frequency that exceeds the flow control threshold. | The application 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 | Invalid access token or application ID. | The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct. |
| 404 | 100403 | The device does not exist. | The device does not exist. Recommended handling: Check whether deviceId is correct. |
| 500 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 500 | 50252 | Internal server error. | An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel. |
Last Article: Deleting a Device
Next Article: Querying Information in a Device Shadow
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.