文档首页> 设备接入 IoTDA> API参考> 应用侧API参考> API> 设备管理> 查询指定设备加入的设备组列表
更新时间：2024-06-14 GMT+08:00
查看PDF

查询指定设备加入的设备组列表

功能介绍

应用服务器可调用此接口查询物联网平台中的某个设备加入的设备组信息列表。仅标准版实例、企业版实例支持该接口调用，基础版不支持。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

device_id

是

String

参数说明：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

Instance-Id

否

String

参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

device_groups

Array of ListDeviceGroupSummary objects

设备组信息列表。
表4 ListDeviceGroupSummary

参数

参数类型

描述

group_id

String

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

name

String

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

description

String

设备组描述。

super_group_id

String

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

group_type

String

参数说明：设备组类型，默认为静态设备组；当设备组类型为动态设备组时，需要填写动态设备组规则

请求示例

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

响应示例

状态码： 200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： 设备管理