调用该接口获取可用于创建设备组的产品列表。

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

请求参数

名称 类型 是否必选 示例值 描述
homeId String 家的 ID,生活物联网平台赋予家的唯一标识符。
pageNo Int 分页页码,从1开始。
pageSize Int 分页大小,取值范围:1~50。

返回数据

名称 类型 示例值 描述
code Int

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

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

total Long

满足条件的产品总数。

pageNo Int

当前页码。

pageSize Int

当前页大小。

data JSON

产品详情列表。

productKey String

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

productName String

设备所隶属的产品名称。

productImage String

产品的图标URL。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1",
		"iotToken": "token"
	},
	"params":{
		"homeId": "value0",
		"pageNo": "value1",
		"pageSize": "value2"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "total":2,
        "pageNo":1,
        "pageSize":10,
        "data":[
            {
                "productKey":"a1UUZIg****",
                "productName":"球泡灯",
                "productImage":"xxx"
            },
            {
                "productKey":"a1b6s3D****",
                "productName":"插座",
                "productImage":"xxx"
            }
        ]
    }
}

异常返回示例

JSON 格式

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