Query a Device Group

Function

This API is used by an application to query details about a specific device group.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:group:query	Read	app *	-	-	-
iotda:group:query	Read	-	g:EnterpriseProjectId	-	-

URI

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

**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.
group_id	Yes	String	Parameter description: device group ID. The ID is unique and is allocated by the platform during device group creation. Value: The value can contain a maximum of 36 characters, including hexadecimal strings and hyphens (-).

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
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
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. Range: DYNAMIC: dynamic group STATIC: static group
dynamic_group_rule	String	Dynamic device group rule.

Example Requests

Queries details about a specified device group.

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

Example Responses

Status code: 200

{
  "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
  "name" : "GroupA",
  "description" : "GroupA",
  "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
  "group_type" : "STATIC"
}