Help Center> IoT> API Reference> Northbound API Reference> Device Group Management> Querying Members in a Specified Device Group
Updated at: 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 devices in a specified device group based on group ID on the IoT platform.

API Prototype

Method

GET

URL

https://server:port/iocm/app/dm/v1.2.0/devices/ids?devGroupId={devGroupId}&accessAppId={accessAppId}&pageNo={pageNo}&pageSize={pageSize}

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.

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.

appId

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 to be queried. The value is an integer greater than or equal to 0. The default value is 0, indicating that 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

Status Code: 200 OK

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.

Request Example

Method: GET
Request:
https://server:port/iocm/app/dm/v1.2.0/devices/ids?devGroupId={devGroupId}&accessAppId={accessAppId}&pageNo={pageNo}&pageSize={pageSize}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json

Response Example

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

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.

close