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

Querying Information About a Specified Device Group

Typical Scenario

An NA can call this API to query information about a specified device group to check the usage of the device group.

API Function

This API is used by an NA to query the information about a device group by device group ID on the IoT platform.

API Description

1
def querySingleDeviceGroup(self, devGroupId, accessAppId, accessToken)

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 belongs to the current application, set this parameter to None. Otherwise, set this parameter to the ID of the authorized application.

accessToken

Mandatory

String

header

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

Response Parameters

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

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.

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.

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.