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

Querying Members in a Specified Device Group

Typical Scenario

An NA can call this API to query information about members in a specified device group.

API Function

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

API Description

1
QueryDeviceGroupMembersOutDTO queryDeviceGroupMembers(QueryDeviceGroupMembersInDTO qdgmInDTO, String accessToken) throws NorthApiException

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

qdgmInDTO

Mandatory

QueryDeviceGroupMembersInDTO structure

query

For details, see QueryDeviceGroupMembersInDTO structure.

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.

QueryDeviceGroupMembersInDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

devGroupId

Mandatory

String

query

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.

pageNo

Optional

Integer

query

Indicates the page number. Default value: 0

  • 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(1000)

query

Indicates the number of devices on each page. The default value is 10.

Response Parameters

QueryDeviceGroupMembersOutDTO structure

Parameter

Type

Description

totalCount

long

Indicates the number of devices in the device group.

pageNo

long

Indicates the page number.

pageSize

long

Indicates the number of devices on each page.

deviceIds

List<String>

Identifies the devices in the device group.

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

400

107001

The serviceId is not exist.

The service ID does not exist.

Recommended handling: Check whether serviceId carried in the API request is correct.

400

107002

The properties is empty in database.

The device attributes do not exist.

Recommended handling: Check whether serviceId carried in the API request is correct.

400

107003

The request properties is unknown.

The device status is unknown.

Recommended handling: Check whether the connection between the device and the IoT platform is normal.

403

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.

403

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

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.

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.