查询指定设备组成员
典型场景
第三方应用若需要查看某个设备组中的设备成员分布情况,可调用此接口查询指定设备组的设备成员列表信息。
接口功能
支持第三方应用在物联网平台根据设备组ID查询指定设备组内设备列表信息。
接口描述
1
|
QueryDeviceGroupMembersOutDTO queryDeviceGroupMembers(QueryDeviceGroupMembersInDTO qdgmInDTO, String accessToken) throws NorthApiException |
参数说明
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
qdgmInDTO |
必选 |
QueryDeviceGroupMembersInDTO |
query |
见下表QueryDeviceGroupMembersInDTO的描述。 |
accessToken |
必选 |
String |
header |
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
devGroupId |
必选 |
String |
query |
设备组ID,在增加设备组后由物联网平台返回获得。 |
accessAppId |
可选 |
String |
query |
如果是本应用的设备组,此参数值可以填写null,否则填写授权应用的appId。 |
pageNo |
可选 |
Integer |
query |
分页查询参数,默认值为0。
|
pageSize |
可选 |
Integer(1000) |
query |
每页设备记录数量,默认值为10。 |
响应参数
QueryDeviceGroupMembersOutDTO
参数 |
类型 |
描述 |
---|---|---|
totalCount |
long |
设备组内设备总数。 |
pageNo |
long |
查询结果页码。 |
pageSize |
long |
每页设备记录数量。 |
deviceIds |
List<String> |
设备组内设备ID列表。 |
错误码
Http状态码 |
错误码 |
错误描述 |
说明 |
---|---|---|---|
400 |
107001 |
The serviceId is not exist. |
服务ID不存在。 处理建议:请检查接口请求中的serviceId是否有误。 |
400 |
107002 |
The properties is empty in database. |
设备属性不存在。 处理建议:请检查接口请求中的serviceId是否有误。 |
400 |
107003 |
The request properties is unknown. |
设备状态为未知。 处理建议:请检查设备与平台的连接是否正常。 |
403 |
100203 |
The application is not existed. |
应用不存在。 处理建议:
|
403 |
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 |
100203 |
The application is not existed. |
应用不存在。 处理建议:
|
500 |
50252 |
Internal server error. |
服务器运行内部错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 |