Query the List of Device Groups to Which a Specified Device Is Added

Function

This API is used by an application to query the list of device groups to which a device in the IoT platform is added. This API is supported only by standard and enterprise editions.

Debugging

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

URI

POST /v5/iot/{project_id}/devices/{device_id}/list-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.
device_id	Yes	String	Parameter description: device ID, which uniquely identifies a device. The value of this parameter is specified during device registration or allocated by the platform. If the value is allocated by the platform, the value is in the format of [product_id][node_id]. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (), and hyphens (-) are allowed.

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
device_groups	Array of ListDeviceGroupSummary objects	Device group information list.

**Table 4** ListDeviceGroupSummary
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.

Example Requests

POST https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/list-device-group

Example Responses

Status code: 200

{
  "device_groups" : [ {
    "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
    "name" : "GroupA",
    "description" : "Group A",
    "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
    "group_type" : "STATIC"
  } ]
}