本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ 设备组管理/ 查询设备组设备列表

查询设备组设备列表

更新时间：2024-10-23 GMT+08:00

查看PDF

功能介绍

应用服务器可调用此接口查询指定设备组下的设备列表。

调试

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

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数说明：项目ID。获取方法请参见获取项目ID。
group_id	是	String	参数说明：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。取值范围：长度不超过36，十六进制字符串和连接符（-）的组合。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数说明：分页查询时每页显示的记录数。取值范围：1-50的整数，默认值为10。
marker	否	String	参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。
offset	否	Integer	参数说明：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。取值范围：0-500的整数，默认为0。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数说明：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。
Instance-Id	否	String	参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
devices	Array of SimplifyDevice objects	设备列表。
page	Page object	查询结果的分页信息。

表5 SimplifyDevice
参数	参数类型	描述
device_id	String	设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "_" + "node_id"拼接而成。
node_id	String	设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。
device_name	String	设备名称。
product_id	String	设备关联的产品ID，用于唯一标识一个产品模型。

表6 Page
参数	参数类型	描述
count	Long	满足查询条件的记录总数。
marker	String	本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

请求示例

查询设备组中设备。

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

响应示例

状态码： 200

{
  "devices" : [ {
    "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
    "node_id" : "ABC123456789",
    "device_name" : "dianadevice",
    "product_id" : "b640f4c203b7910fc3cbd446ed437cbd"
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}

状态码

状态码	描述
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： 设备组管理

上一篇：管理设备组中的设备

下一篇：标签管理

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消