文档首页 > > API参考> 应用侧API参考> 设备组管理> 查询设备组列表

查询设备组列表

分享
更新时间: 2019/12/11 GMT+08:00

接口说明

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

URI

请求方法

GET

URI

/iocm/app/devgroup/v1.3.0/devGroups

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。

Authorization

必选

String

header

访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。

accessAppId

可选

String

query

设备组所属的应用ID,当查询授权应用下的设备组时才需要填写。

pageNo

可选

Integer

query

分页查询参数,查询结果分页显示时指定要查看的页信息,默认值0,查询第一页,取值范围为大于等于0的整数。

pageSize

可选

Integer

query

分页查询参数,查询结果分页显示时每页显示的记录数,默认值为1,取值范围为1-500的整数。

name

可选

String

query

设备组名称。

响应参数

StatusCode: 200 ok

参数

类型

描述

totalCount

long

设备组总数。

pageNo

long

查询结果页码。

pageSize

long

每页设备组记录数量。

list

List<QueryDevGroupDTOCloud2NA>

设备组信息详情。

QueryDevGroupDTOCloud2NA:

参数

类型

描述

name

String(50)

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

description

String(1024)

设备组的描述信息。

id

String(50)

设备组ID。

appId

String(50)

设备组所属的应用ID。

maxDevNum

Integer(>=0)

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

curDevNum

Integer

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

creator

String(1-50)

创建设备组的用户名称。

请求示例

GET https://{host}:{port}/iocm/app/devgroup/v1.3.0/devGroups?accessAppId={accessAppId}&pageNo={pageNo}&pageSize={pageSize}&name={name}
Content-Type: application/json
app_key: ******
Authorization: Bearer ******

正常响应示例

Status Code: 200 OK
Content-Type: application/json

{
  "totalCount": "********",
  "pageNo": "******",
  "pageSize": "********",
  "list": [
    "object"
  ]
}

错误码

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.

服务器运行内部错误。

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

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区