创建设备分组
功能介绍
应用服务器可调用此接口创建设备分组
URI
POST /v1/iotfm/groups
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数说明:用户Token。通过调用 生成Token 接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
X-Instance-Id |
是 |
String |
参数说明:实例ID。通过访问智能设施云平台界面后获取,智能设施云平台资源均为实例级隔离,所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围:长度8-36,只允许大小写字母、数字和-字符的组合。 |
X-Root-Zone-Id |
否 |
String |
参数说明:项目ID。 取值范围:长度不超过24,只允许字母、数字的组合。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_name |
是 |
String |
参数说明:设备分组名称。 取值范围:长度不超过128,只允许中文、字母、数字、以及_-字符的组合。 |
subgroups |
是 |
Array of ProductDeviceGroup objects |
参数说明:子分组,支持多产品及对应设备,总设备数不超过100。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
参数说明:设备分组ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 |
group_name |
String |
参数说明:设备分组名称。 取值范围:长度不超过128,只允许中文、字母、数字、以及_-字符的组合。 |
create_time |
String |
格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
update_time |
String |
格式为:"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
subgroups |
Array of SubGroupInfo objects |
参数说明:子分组,支持多产品及对应设备。 取值范围:总设备数不超过100。 |
参数 |
参数类型 |
描述 |
---|---|---|
product_id |
String |
参数说明:产品ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 |
devices |
Array of GroupDeviceInfo objects |
参数说明:设备分组ID列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
zone_id |
String |
参数说明:区域ID。 取值范围:长度不超过24,只允许字母、数字的组合。 |
zone_name |
String |
参数说明:区域名称。 取值范围:长度不超过64。 |
product_id |
String |
参数说明:产品ID。 取值范围:长度不超过36,只允许字母、数字、以及_-字符的组合。 |
product_name |
String |
参数说明:产品名称。 取值范围:长度不超过64。 |
device_id |
String |
参数说明:设备ID。 取值范围:长度不超过128,只允许字母、数字、以及_-字符的组合。 |
device_name |
String |
参数说明:设备名称。 取值范围:长度不超过64,只允许中文、字母、数字、以及_-字符的组合。 |
device_status |
String |
参数说明:设备状态。 取值范围: |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数说明:错误码。 取值范围:长度8-36。 |
error_msg |
String |
参数说明:错误描述。 取值范围:长度2-512。 |
请求示例
创建设备分组
POST https://{endpoint}/v1/iotfm/edge/groups { "group_name" : "边缘设备分组", "subgroups" : [ { "product_id" : "18c9fa374df47041550bea48", "devices" : [ "123123123" ] }, { "product_id" : "18827a0adec6c6371706baeaedge_gw", "devices" : [ "937032984819937280" ] } ] }
响应示例
状态码:201
Created
{ "group_id" : "18ca648c5df3e84c6350ed59", "group_name" : "边缘设备分组", "subgroups" : [ { "product_id" : "18827a0adec6c6371706baeaedge_gw", "devices" : [ { "zone_id" : "18bc8551638d8ce541c32cf5", "zone_name" : "preset_zone_01", "product_id" : "18827a0adec6c6371706baeaedge_gw", "product_name" : "18827a0adec6c6371706baeaedge_gw", "device_id" : "937032984819937280", "device_name" : "边缘网关_v2", "device_status" : "INACTIVE" } ] }, { "product_id" : "18c9fa374df47041550bea48", "devices" : [ { "zone_id" : "18bc8551638d8ce541c32cf5", "zone_name" : "preset_zone_01", "product_id" : "18c9fa374df47041550bea48", "product_name" : "路灯", "device_id" : "123123123", "device_name" : "机电设备", "device_status" : "INACTIVE" } ] } ] }
状态码
状态码 |
描述 |
---|---|
201 |
Created |
400 |
Bad Request |