Deleting a Device Group
Typical Scenario
If a device group is no longer needed on the IoT platform due to group changes, an NA can call this API to delete a specified device group.
API Function
This API is used by an NA to delete the configuration information about a device group by device group ID on the IoT platform.
API Description
1 |
void deleteDeviceGroup(String devGroupId, String accessAppId, String accessToken) throws NorthApiException
|
Parameter Description
Parameter |
Mandatory or Optional |
Type |
Location |
Description |
---|---|---|---|---|
devGroupId |
Mandatory |
String |
path |
Identifies a device group. The value of this parameter is returned by the IoT platform after the device group is added. |
accessAppId |
Optional |
String |
query |
If the device group 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. |
Response Parameters
void
Error Codes
HTTP Status Code |
Error Code |
Error Description |
Remarks |
---|---|---|---|
200 |
100203 |
The application is not existed. |
The application does not exist. Recommended handling:
|
200 |
100217 |
The application hasn't been authorized |
The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null. |
200 |
100603 |
The device group is not existed |
The device group does not exist. Recommended handling: Check whether the device group ID 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 |
50252 |
Internal server error. |
An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot