Updated on 2022-02-24 GMT+08:00

Querying Details About a Device Group

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 Description

1
def queryDeviceGroups(self, qdgInDTO, accessToken)

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

qdgInDTO

Mandatory

QueryDeviceGroupsInDTO

query

For details, see QueryDeviceGroupsInDTO.

accessToken

Mandatory

String

header

This parameter is set to the value of the access token obtained by calling the Authentication API.

QueryDeviceGroupsInDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

accessAppId

Optional

String

query

If the device group belongs to the current application, set this parameter to None. Otherwise, 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

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<object>

Indicates the device group details.

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.