V2.5 Create Device Group¶
创建设备组。
操作权限¶
需授权的服务 |
所需操作权限 |
---|---|
设备管理 |
Full Access |
请求格式¶
POST https://{apigw-address}/connect-service/v2.5/deviceGroups?action=createGroup
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织 ID。如何获取 orgId 信息>> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
name |
必需 |
StringI18n |
设备组国际化名称,结构参见 国际化名称结构体。 |
desc |
可选 |
String |
固件描述。 |
type |
必需 |
String |
设备组类型:STATIC、DYNAMIC。 |
condition |
可选 |
String |
动态设备组条件。更多信息,参见 动态规则。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
code |
Number |
响应码 |
msg |
String |
对状态码的解释和说明。请求成功为 “OK”。 |
requestId |
String |
每次请求获取的ID,用于唯一标识一次API请求。 |
data |
String |
设备组的ID。 |
错误码¶
代码 |
错误信息 |
描述 |
---|---|---|
900 |
Condition error of dynamic group. |
动态组的条件错误。 |
901 |
Exceed device max limit of static group. |
静态组的设备数量超出最大限制。 |
902 |
Exceed static group max limit of device. |
设备的静态组数量超出最大限制。 |
903 |
Exceed static group max limit. |
静态组数量超出最大限制。 |
904 |
Exceed dynamic group max limit. |
动态组数量超出最大限制。 |
905 |
Exceed initial device max limit of dynamic group. |
动态组的初始设备数量超出最大限制。 |
906 |
Device is already in a static group. |
设备已在一个静态组中。 |
906 |
device is not in static group. |
设备不在静态组中。 |
404 |
Device group can not be found. |
找不到设备组。 |
500 |
Internal error. |
内部错误。 |
400 |
Invalid argument. |
参数无效。 |
示例¶
请求示例¶
url:https://{apigw-address}/connect-service/v2.5/deviceGroups?action=createStaticGroup&orgId=yourOrgId
method: POST
requestBody:
{
"name": {
"defaultValue": "GroupName-test",
"i18nValue": {
"en_US": "name",
"zh_CN": "中文名",
"es_ES": "nombre",
"ja_JP": "名前"
}
},
"desc": "deviceGroupDescription"
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "d0c39299-912a-44c5-8894-cf893352f9ab",
"data": "devicegroupid"
}