Query the Device Group List

Function

This API is used by an application to query the device group list on the IoT platform.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v5/iot/{project_id}/device-group

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Parameter description: number of records to display on each page. Value: The value is an integer ranging from 1 to 50. The default value is 10.
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time. Value: The value is a string of 24 hexadecimal characters. The default value is ffffffffffffffffffffffff.
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. If offset is set to 0, the output starts from the first record after the last record in the previous query. To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query. Value: The value is an integer ranging from 0 to 500. The default value is 0.
last_modified_time	No	String	Parameter description: Modification records of a device group after the time specified by last_modified_time are queried. Value: The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.
app_id	No	String	Parameter description: resource space ID. This parameter is optional. It is used by users who have multiple resource spaces to query the product list of a specified resource space. If this parameter is not carried, the list of all products of the user will be returned. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
group_type	No	String	Parameter description: device group type. A static device group is used by default. When a dynamic device group is used, enter the dynamic device group rule.
name	No	String	Parameter description: device group name, which must be unique in a single resource space. Value: The value can contain a maximum of 64 characters. Only letters, digits, underscores (_), and question marks (?) are allowed. '#().,& %@!-.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. X-Subject-Token in the response header returned by the API is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
device_groups	Array of DeviceGroupResponseSummary objects	Device group information list.
page	Page object	Pagination information of the query results.

**Table 5** DeviceGroupResponseSummary
Parameter	Type	Description
group_id	String	Device group ID. The ID is unique and is allocated by the platform during device group creation.
name	String	Device group name, which must be unique in a single resource space.
description	String	Device group description.
super_group_id	String	ID of the parent device group.
group_type	String	Parameter description: device group type. A static device group is used by default. When a dynamic device group is used, enter the dynamic device group rule.

**Table 6** Page
Parameter	Type	Description
count	Long	Total number of records that meet the query conditions.
marker	String	ID of the last record in this query, which can be used in the next query.

Example Requests

Queries a device group list.

GET https://{endpoint}/v5/iot/{project_id}/device-group

Example Responses

Status code: 200

{
  "device_groups" : [ {
    "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
    "name" : "GroupA",
    "description" : "GroupA",
    "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
    "group_type" : "STATIC"
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}