Querying the Device Group List

Typical Scenario

An NA 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 NA to query information about all created device groups on the IoT platform.

API Prototype

Method	GET
URL	https://server:port/iocm/app/devgroup/v1.3.0/devGroups?accessAppId={accessAppId}&pageNo={pageNo}&pageSize={pageSize}&name={name}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
accessAppId	Optional	String	query	This parameter must be specified when you want to query information about a device group under an authorized application. Set this parameter to the ID of the authorized application.
pageNo	Optional	Integer	query	Indicates the page number. If the value is null, pagination query is not performed. If the value is an integer greater than or equal to 0, pagination query is performed. If the value is 0, the first page is queried.
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

Status Code: 200 OK

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<QueryDevGroupDTOCloud2NA>	Indicates the device group details.

QueryDevGroupDTOCloud2NA 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 a 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 creates the device group.

Request Example

Method: GET
Request:
https://server:port/iocm/app/devgroup/v1.3.0/devGroups?accessAppId={accessAppId}&pageNo={pageNo}&pageSize={pageSize}&name={name}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "totalCount": "********",
  "pageNo": "******",
  "pageSize": "********",
  "list": [
    "object"
  ]
}

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
200	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.
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.
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.