更新时间:2024-07-01 GMT+08:00
分享

查询设备组详情

典型场景

第三方应用可调用此接口查询当前已创建的所有设备组列表信息,以了解当前设备组的分组和使用情况。

接口功能

支持第三方应用在物联网平台查询已创建的所有设备组信息。

接口描述

1
QueryDeviceGroupsOutDTO queryDeviceGroups(QueryDeviceGroupsInDTO qdgInDTO, String accessToken) throws NorthApiException

参数说明

参数

必选/可选

类型

位置

描述

qdgInDTO

必选

QueryDeviceGroupsInDTO

query

见下表QueryDeviceGroupsInDTO的描述。

accessToken

必选

String

header

如果调用了定时刷新token接口,此参数值可以填写null,否则要填写鉴权接口获取的accessToken。

QueryDeviceGroupsInDTO

参数

必选/可选

类型

位置

描述

accessAppId

可选

String

query

如果是本应用的设备组,此参数值可以填写null,否则填写授权应用的appId。

pageNo

可选

Integer

query

分页查询参数。

  • 值为空时,查询内容不分页。
  • 值为大于等于0的整数时,分页查询。
  • 值为0时查询第一页。

pageSize

可选

Integer

query

每页设备组记录数量,默认值为1。

name

可选

String

query

设备组名称。

响应参数

QueryDeviceGroupsOutDTO

参数

类型

描述

totalCount

long

设备组总数。

pageNo

long

查询结果页码。

pageSize

long

每页设备组记录数量。

list

List<QuerySingleDeviceGroupOutDTO>

设备组信息详情,具体参见QuerySingleDeviceGroupOutDTO结构体。

QuerySingleDeviceGroupOutDTO结构体说明:

参数

类型

描述

name

String(50)

设备组名称,仅限大小写字母和数字。

description

String(1024)

设备组的描述信息。

id

String(50)

设备组ID。

appId

String(50)

设备组所属的应用ID。

maxDevNum

Integer(>=0)

设备组设备最大数量限制,当值为0时,表示对设备数量不做限制。

curDevNum

Integer

当前设备组内的设备数量。

creator

String(1-50)

创建设备组的用户名称。

错误码

Http状态码

错误码

错误描述

说明

200

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

200

100217

The application hasn't been authorized.

应用未被授权。

处理建议:若非应用授权场景,请确认请求参数中的appId为空。

403

1010009

app throttle exceed.

应用调用接口过于频繁,超过流控值(默认值是100次/60s)。

处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。

403

1010005

Invalid access token or appId.

错误的Token信息。

处理建议:请检查接口请求中所携带的accessToken是否有误。

500

50252

Internal server error.

服务器运行内部错误。

处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。

相关文档