Help Center> IoT Device Access> API Reference> 应用侧API参考> 设备组管理> 查询设备组
View PDF

查询设备组

接口说明

应用服务器可调用此接口查询指定设备组详情。

调试

您可以在API Explorer中直接运行调试该接口。

URI

请求方法

GET

URI

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

传输协议

HTTPS

请求参数

名称

必选/可选

类型

位置

说明

X-Auth-Token

必选

String

Header

参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

Instance-Id

可选

String

Header

参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。

project_id

必选

String

Path

参数说明：项目ID。获取方法请参见 获取项目ID。

group_id

必选

String

Path

参数说明：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。

取值范围：长度不超过36，十六进制字符串和连接符（-）的组合。

响应参数

名称

类型

说明

group_id

String

设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。

name

String

设备组名称，单个资源空间下不可重复。

description

String

设备组描述。

super_group_id

String

父设备组ID，该设备组的父设备组ID。

请求示例

GET https://{Endpoint}/v5/iot/{project_id}/device-group/{group_id}
Content-Type: application/json
X-Auth-Token: ********
Instance-Id: ********

响应示例

Status Code: 200 OK

Content-Type: application/json

{
  "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
  "name" : "GroupA",
  "description" : "群组A",
  "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8"
}

错误码

HTTP状态码

错误码

错误码英文描述

错误码中文描述

处理建议

403

IOTDA.000021

Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.

没有找到IAM Token所对应的用户信息或该用户没有订阅设备接入服务（IOTDA）

请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。

IOTDA.000022

Operation not allowed. The user does not have the permission

该用户没有权限

请排查该用户是否有权限访问。

IOTDA.001006

Operation not allowed. Application not found by authorized user or the authorized user has no application.

用户下没有应用或应用与用户不匹配

请排查用户下是否有应用或是否有指定的应用。

IOTDA.001007

Operation not allowed. The application does not belong to the authorized user.

应用与用户信息不匹配

请排查该用户下是否有指定的应用。

404

IOTDA.003000

The group does not exist.

群组不存在

请确认是否有该设备组或设备组参数是否携带正确。

500

IOTDA.000020

Decrypt IAM token failed.

IAM Token解析失败

请联系华为工程师分析解决。
父主题： 设备组管理