查询指定设备组成员
接口说明
应用服务器若需要查看某个设备组中的设备成员分布情况，可调用此接口查询指定设备组的设备成员列表信息。
URI
| 请求方法 | GET |
|---|---|
| URI | /iocm/app/dm/v1.2.0/devices/ids |
| 传输协议 | HTTPS |
请求参数
| 参数 | 必选/可选 | 类型 | 位置 | 描述 |
|---|---|---|---|---|
| app_key | 必选 | String | header | 访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。 |
| Authorization | 必选 | String | header | 访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。 |
| devGroupId | 必选 | String | query | 设备组ID，在增加设备组后由物联网平台返回获得。 |
| appId | 可选 | String | query | 设备组所属的应用ID，当创建授权应用下的设备组成员时才需要填写。 |
| pageNo | 可选 | Integer | query | 分页查询参数，查询结果分页显示时指定要查看的页信息，默认值0，查询第一页，取值范围为大于等于0的整数。 |
| pageSize | 可选 | Integer(1000) | query | 分页查询参数，查询结果分页显示时每页显示的记录数，默认值为10，取值范围为大于等于1的整数。 |
响应参数
StatusCode: 200 ok
| 参数 | 类型 | 描述 |
|---|---|---|
| totalCount | long | 设备组内设备总数。 |
| pageNo | long | 查询结果页码。 |
| pageSize | long | 每页设备记录数量。 |
| deviceIds | List<String> | 设备组内设备ID列表。 |
请求示例
GET https://{host}:{port}/iocm/app/dm/v1.2.0/devices/ids?devGroupId={devGroupId}&accessAppId={accessAppId}&pageNo={pageNo}&pageSize={pageSize}
Content-Type: application/json
app_key: ******
Authorization: Bearer ****** 正常响应示例
Status Code: 200 OK
Content-Type: application/json
{
"totalCount": "********",
"pageNo": "******",
"pageSize": "********",
"deviceIds": [
"********",
"********",
"********"
]
} 错误码
| 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. | 服务器运行内部错误。 处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。 |
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.