添加设备组
功能介绍
应用服务器可调用此接口新建设备组，一个华为云账号下最多可有1,000个设备组，包括父设备组和子设备组。设备组的最大层级关系不超过5层，即群组形成的关系树最大深度不超过5。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v5/iot/{project_id}/device-group
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数说明：设备组名称，单个资源空间下不可重复。 取值范围：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。 |
|
description |
否 |
String |
参数说明：设备组描述。 取值范围：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。 |
|
super_group_id |
否 |
String |
参数说明：父设备组ID，携带该参数时表示在该设备组下创建一个子设备组,动态群组不支持该参数。 取值范围：长度不超过36，十六进制字符串和连接符（-）的组合。 |
|
app_id |
否 |
String |
参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的设备组归属到哪个资源空间下，否则创建的设备组将会归属到默认资源空间下。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
group_type |
否 |
String |
参数说明：设备组类型，默认为静态设备组；当设备组类型为动态设备组时，需要填写动态设备组组规则 |
|
dynamic_group_rule |
否 |
String |
参数说明：动态设备组规则语法和高级搜索保持一致，只需要填写where 子句内容，其余子句无需填写，todo补充说明 |
响应参数
状态码： 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
group_id |
String |
设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 |
|
name |
String |
设备组名称，单个资源空间下不可重复。 |
|
description |
String |
设备组描述。 |
|
super_group_id |
String |
父设备组ID，该设备组的父设备组ID。 |
|
group_type |
String |
设备组类型，分为动态设备组和静态设备组两种 |
|
dynamic_group_rule |
String |
动态设备组规则 |
请求示例
-
创建静态设备组，设备组名为GroupA。
POST https://{endpoint}/v5/iot/{project_id}/device-group { "name" : "GroupA", "description" : "群组A", "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "group_type" : "STATIC" } -
创建动态设备组，设备组名为GroupA。
POST https://{endpoint}/v5/iot/{project_id}/device-group { "name" : "GroupA", "description" : "群组A", "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "dynamic_group_rule" : "product_id = '63fef97897bacf7a56438cba'", "group_type" : "DYNAMIC" }
响应示例
状态码： 201
Created
{
"group_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
"name" : "GroupA",
"description" : "群组A",
"super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
"group_type" : "STATIC",
"dynamic_group_rule" : null
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
