调用该接口获取指定设备组的详细信息。

路径 /living/home/controlgroup/get
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 是
超时时间 15000

请求参数

名称 类型 是否必选 示例值 描述
controlGroupId String 是 50f5op1556f65de****983fd5bca4f2f28104516 设备组ID，生活物联网平台赋予设备组的唯一标识符。
homeId String 是 50f5op1556f65de****983fd5bca4f2f28104512 家的ID，生活物联网平台赋予家的唯一标识符。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。
message String

调用失败时，返回的出错信息。
localizedMsg String

本地语言的错误信息。
data JSON

响应的结果。
controlGroupId String

设备组ID，生活物联网平台赋予设备组的唯一标识符。
name String

设备组的名称。
createMillis Long

设备组的创建时间。格式为UNIX时间戳。单位：毫秒。
productKey String

设备组所属产品的Key，设备证书信息之一。创建产品时，生活物联网平台为该产品颁发的全局唯一标识。
productImage String

设备组所属产品的图标地址。如https://xxx/xxx.png。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1",
		"iotToken": "token"
	},
	"params":{
		"controlGroupId": "50f5op1556f65de****983fd5bca4f2f28104516",
		"homeId": "50f5op1556f65de****983fd5bca4f2f28104512"
	}
}

正常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data":{
        "controlGroupId":"xxx",
        "name":"xxx",
        "productKey":"xxx",
        "productImage":"xxx",
        "createMillis":1569232952000
    }
}

异常返回示例

JSON 格式 

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}