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

查询指定设备组

典型场景

第三方应用若需要查看某个设备组的信息,以了解该设备组的使用情况,可调用此接口查询指定设备组的信息。

接口功能

支持第三方应用在物联网平台根据设备组ID查询指定设备组的信息。

接口描述

1
QuerySingleDeviceGroupOutDTO querySingleDeviceGroup(String devGroupId, String accessAppId, String accessToken) throws NorthApiException

参数说明

参数

必选/可选

类型

位置

描述

devGroupId

必选

String

path

设备组ID,在增加设备组后由物联网平台返回获得。

accessAppId

可选

String

query

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

accessToken

必选

String

header

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

响应参数

QuerySingleDeviceGroupOutDTO

参数

类型

描述

name

String(50)

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

description

String(1024)

设备组的描述信息。

id

String(50)

设备组ID。

appId

String(50)

设备组所属的应用ID。

maxDevNum

Integer(>=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为空。

200

100603

The device group is not existed.

设备组不存在。

处理建议:请检查设备组ID是否正确。

403

1010009

app throttle exceed.

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

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

403

1010005

Invalid access token or appId.

错误的token信息。

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

500

50252

Internal server error.

服务器运行内部错误。

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

相关文档