Querying Device Groups
Typical Scenario
An application can call this API to query information of all the created device groups to check the group details and usage of the device groups.
API Function
This API is used by an application to query information about all created device groups on the platform.
API Description
1 | QueryDeviceGroupsOutDTO queryDeviceGroups(QueryDeviceGroupsInDTO qdgInDTO, String accessToken) throws NorthApiException
|
Parameter Description
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| qdgInDTO | Mandatory | QueryDeviceGroupsInDTO | query | For details, see QueryDeviceGroupsInDTO. |
| 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. |
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| 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. |
| pageNo | Optional | Integer | query | Indicates the page number.
|
| pageSize | Optional | Integer | query | Indicates the number of device group records on each page. The default value is 1. |
| name | Optional | String | query | Indicates the device group name. |
Response Parameters
QueryDeviceGroupsOutDTO structure
| Parameter | Type | Description |
|---|---|---|
| totalCount | long | Indicates the total number of device groups. |
| pageNo | long | Indicates the page number. |
| pageSize | long | Indicates the number of device group records on each page. |
| list | List<QuerySingleDeviceGroupOutDTO> | Indicates details about the device group. For details, see QuerySingleDeviceGroupOutDTO structure. |
QuerySingleDeviceGroupOutDTO structure
| Parameter | Type | Description |
|---|---|---|
| name | String(50) | Indicates the device group name. The value can contain only uppercase and lowercase letters and digits. |
| description | String(1024) | Indicates the device group description. |
| id | String(50) | Identifies the device group. |
| appId | String(50) | Identifies the application to which the device group belongs. |
| maxDevNum | Integer(>=0) | Indicates the maximum number of devices in the device group. If the value is 0, the number of devices is not limited. |
| curDevNum | Integer | Indicates the current number of devices in the device group. |
| creator | String(1-50) | Indicates the name of the user who created the device group. |
Error Codes
| HTTP Status Code | Error Code | Error Description | Remarks |
|---|---|---|---|
| 200 | 100203 | The application does not exist. | The application does not exist. Recommended handling:
|
| 200 | 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. |
| 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: Modifying a Device Group
Next Article: Querying Details of a Device Group
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.