更新时间:2022-02-24 GMT+08:00

增加设备组成员

典型场景

若需要把新增的设备或已有设备增加到某个设备组中,应用服务器可调用此接口向指定设备组添加设备成员。在向设备组添加设备前,建议通过“查询指定设备组”接口查询该设备组的当前设备数量及最大设备数量限制,确保设备组中还有足够的可添加成员数量。

接口功能

支持应用服务器在物联网平台向指定设备组添加设备。

接口原型

请求方法

POST

请求地址

https://server:port/iocm/app/dm/v1.1.0/devices/addDevGroupTagToDevices?accessAppId={accessAppId}

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

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

Authorization

必选

String

header

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

accessAppId

可选

String

query

当向授权应用下的设备组添加设备时需要填写,填写授权应用的应用ID。

devGroupId

必选

String(1-50)

body

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

deviceIds

必选

List<String>(1000)

body

要添加到设备组的设备ID列表。

返回参数

StatusCode: 200 ok

参数

类型

描述

devGroupId

String(1-50)

设备组ID。

deviceIds

List<String>

添加到设备组的设备ID列表。

请求示例

Method: POST
request:
https://server:port/iocm/app/dm/v1.1.0/devices/addDevGroupTagToDevices?accessAppId={accessAppId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json
Body:
{
  "devGroupId": "******",
  "deviceIds": [
    "********",
    "********",
    "********"
  ]
}

响应示例

response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "devGroupId": "******",
  "deviceIds": [
    "********",
    "********",
    "********"
  ]
}

错误码

Http状态码

错误码

错误描述

说明

200

100601

The number of device in the group has reach the max.

设备组内设备达到最大值。

处理建议:请确认当前设备组内的设备数量在maxDevNum设置值的范围内。

200

100603

The device group is not existed.

设备组不存在。

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

400

100604

The device group request parameter is invalid.

请求参数不合法。

处理建议:

  • 请检查接口请求中的设备ID是否有误。
  • 请检查设备组是否达到最大设备数量限制。

400

50400

The input is invalid.

输入参数无效。

处理建议:请检查接口调用请求中携带参数的合法性。

403

100203

The application is not existed.

应用不存在。

处理建议:

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

403

100217

The application hasn't been authorized.

应用未被授权。

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

403

1010009

app throttle exceed.

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

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

403

1010005

App_key or access_token is invalid.

错误的Token信息。

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

500

100203

The application is not existed.

应用不存在。

处理建议:

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

500

50252

Internal server error.

服务器运行内部错误。

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