调用该接口在指定家下创建设备组。必须同一个productKey下的设备才能组建设备组。单个家下最多支持创建20个设备组且设备组名称不允许重复;单个设备组下最少2个设备,最多100个设备;一个设备只能添加到一个设备组。目前只支持“灯”和“插座”两个品类。
路径 | /living/home/controlgroup/create |
版本号 | 1.0.3 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 15000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
homeId | String | 是 | 50f5op1556f65de****983fd5bca4f2f28104512 | 家的ID,生活物联网平台赋予家的唯一标识符。 |
name | String | 是 | controlG****Name | 设备组的名称。 |
productKey | String | 是 | a1U****Mvsk | 设备组所属产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
iotIdList | List | 是 | ["iotId1", "iotId2"] | 待添加到设备组内的设备ID列表。 |
enableLocalControl | Boolean | 否 | true | 设备组是否启用本地控制能力。true(表示启用),false(表示不启用)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误信息。 |
|
data | String |
设备组ID,生活物联网平台赋予设备组的唯一标识符。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.3",
"iotToken": "token"
},
"params":{
"homeId": "50f5op1556f65de****983fd5bca4f2f28104512",
"name": "controlG****Name",
"productKey": "a1U****Mvsk",
"iotIdList":[
"iotId1",
"iotId2"
],
"enableLocalControl":true
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "50f5op1556f65de314b983fd5bca4f2f2810****"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}