创建设备组
典型场景
应用服务器可调用此接口在物联网平台上创建设备组，并把设备归类到不同的设备组内，进行分组管理。一个设备可以归属到多个设备组内。
在对设备进行某些操作时（如升级设备软固件、批量下发命令等），可通过设备组来指定要进行操作的设备。
接口功能
支持应用服务器在物联网平台创建设备组，用于对设备进行分组管理。
接口原型
请求方法 |
POST |
|---|---|
请求地址 |
https://server:port/iocm/app/devgroup/v1.3.0/devGroups |
传输协议 |
HTTPS |
请求参数
参数 |
必选/可选 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
app_key |
必选 |
String |
header |
访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。 |
Authorization |
必选 |
String |
header |
访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。 |
name |
必选 |
String(1-50) |
body |
设备组名称，仅限大小写字母和数字。 |
description |
可选 |
String(1024) |
body |
设备组的描述信息。 |
appId |
可选 |
String（50） |
body |
当在授权应用下增加设备组时需要填写，填写授权应用的应用ID。 |
maxDevNum |
可选 |
Integer（>=0） |
body |
设备组设备最大数量，默认最小值为0。当值为0时，表示对设备数量不做限制。 |
deviceIds |
可选 |
List<String> |
body |
添加到设备组的设备ID列表。 |
响应参数
StatusCode: 200 ok
参数 |
类型 |
描述 |
|---|---|---|
name |
String(50) |
设备组名称，仅限大小写字母和数字。 |
description |
String(1024) |
设备组的描述信息。 |
id |
String(50) |
设备组ID。 |
appId |
String(50) |
设备组所属的应用ID。 |
maxDevNum |
Integer（>=0） |
设备组设备最大数量限制，当值为0时，表示对设备数量不做限制。 |
curDevNum |
Integer |
当前设备组内的设备数量。 |
deviceIds |
List<String> |
添加到设备组的设备ID列表。 |
请求示例
Method: POST
request:
https://server:port/iocm/app/devgroup/v1.3.0/devGroups
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json
Body:
{
"name": "********",
"description": "******",
"appId": "********",
"maxDevNum": "********",
"deviceIds": [
"********",
"********",
"********"
]
}
响应示例
response:
Status Code: 201 OK
Content-Type: application/json
Body:
{
"name": "********",
"description": "******",
"id": "********",
"appId": "********",
"maxDevNum": "********",
"curDevNum": "********",
"deviceIds": [
"********",
"********",
"********"
]
}
错误码
Http状态码 |
错误码 |
错误描述 |
说明 |
|---|---|---|---|
200 |
100203 |
The application is not existed. |
应用不存在。 处理建议：
|
200 |
100217 |
The application hasn't been authorized. |
应用未被授权。 处理建议：若非应用授权场景，请确认请求参数中的appId为空。 |
200 |
100602 |
The device group name has been used. |
设备组名字已经存在。 处理建议：请修改接口请求中的设备组名称。 |
200 |
100607 |
The devGroup has reached the limit. |
设备组数目达到限制。 处理建议：请检查已创建的设备组数量是否已达到License限定的数量上限。 |
400 |
100609 |
Too much devices to add. |
添加太多设备至设备组。 处理建议：请确认deviceIds中的设备ID数量在maxDevNum设置值的范围内。 |
400 |
50400 |
The input is invalid. |
输入参数无效。 处理建议：请检查接口调用请求中携带参数的合法性。 |
403 |
1010009 |
app throttle exceed. |
应用调用接口过于频繁，超过流控值（默认值是100次/60s）。 处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 |
403 |
1010005 |
App_key or access_token is invalid. |
错误的token信息。 处理建议：请检查接口请求中所携带的accessToken是否有误。 |
500 |
50252 |
Internal server error. |
服务器运行内部错误。 处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。 |
