调用该接口获取家下的设备列表,支持多维度检索。
路径 | /living/home/device/query |
版本号 | 1.0.2 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
deviceNodeType | String | 否 | GATEWAY, DEVICE | 设备节点类型。DEVICE(设备),GATEWAY(网关)。 |
productKey | String | 否 | a1U2****UZI | 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
categoryKey | String | 否 | value1 | 产品的品类key。即categoryKey。 |
homeId | String | 否 | WocVfjef****Wjdf1vfd21f | 家的ID,生活物联网平台赋予家的唯一标识符。用于过滤归属在某一个家下的设备列表。 |
roomId | String | 否 | 50f5op15****14b983fd5bca4f2f2 | 房间的ID,生活物联网平台赋予房间的唯一标识。用于过滤归属在某一个房间下的设备列表。 |
excludedHomeId | String | 否 | XXX的家 | 家的ID,生活物联网平台赋予家的唯一标识符。用于过滤不属于某一个家下的设备列表。 |
excludedRoomId | String | 否 | XXX的房间 | 房间的ID,生活物联网平台赋予房间的唯一标识。用于过滤不属于某一个房间下的设备列表。 |
boundControlGroup | Boolean | 否 | true | 设备组的绑定状态。true (已绑定设备组),false (未绑定设备组)。 |
pageNo | Int | 是 | 1 | 分页页码,从1开始。 |
pageSize | Int | 是 | 10 | 分页大小。取值范围:1~20。 |
propertyIdentifiers | List | 否 | ["LightSwitch", "PowerSwitch"] | 用于过滤产品TSL属性运行态数据的标识符identifier列表。 |
返回数据
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.2",
"iotToken": "token"
},
"params":{
"deviceNodeType": "GATEWAY, DEVICE",
"productKey": "a1U2****UZI",
"categoryKey": "value1",
"homeId": "WocVfjef****Wjdf1vfd21f",
"roomId": "50f5op15****14b983fd5bca4f2f2",
"excludedHomeId": "XXX的家",
"excludedRoomId": "XXX的房间",
"boundControlGroup":true,
"pageNo":1,
"pageSize":10,
"propertyIdentifiers":[
"LightSwitch",
"PowerSwitch"
]
}
}
正常返回示例
JSON
格式
{
"id":"4de2c367-c1db-417c-aa15-8c585e595d92",
"code":200,
"message":"success",
"localizedMsg":"",
"items":{
"total":2,
"pageNo":1,
"pageSize":10,
"data":[
{
"iotId":"edwB6TqvOW2iXnm****a000100",
"myRole":"OWNED",
"deviceName":"摄像头1",
"homeId":"50f5op1556f65de314b983fd5bca4f2f2810****",
"homeName":"我的家",
"roomId":"50f5op1556f65de314b983fd5bca4f2f2810****",
"roomName":"Xbox 游戏室",
"productKey":"产品 pk",
"productName":"产品名称",
"productImage":"产品图片",
"productModel":"产品型号",
"categoryKey":"Camera",
"categoryImage":"xxx",
"panelPageRouterUrl":"xxx",
"nickName":"设备昵称",
"netType":"NET_WIFI",
"thingType":"DEVICE",
"status":1,
"nodeType":"DEVICE",
"description":"设备描述",
"subDeviceIotIdList":[
"xadqskpHGoswW8lo****000100"
],
"propertyList":[
{
"identifier":"LightSwitch",
"name":"电源开关",
"value":"0",
"dataType":"BOOL",
"imageUrl":"",
"latestUpdateMillis":1588145461000
}
]
},
{
"iotId":"xadqskpHGoswW8l*****00100",
"myRole":"OWNED",
"deviceName":"摄像头2",
"homeId":"50f5op1556f65de314b983fd5bca4f2f2810****",
"homeName":"我的家",
"roomId":"50f5op1556f65de314b983fd5bca4f2f2810****",
"roomName":"Xbox 游戏室",
"productKey":"产品 pk",
"productName":"产品名称",
"productImage":"产品图片",
"productModel":"产品型号",
"categoryKey":"Camera",
"categoryImage":"xxx",
"panelPageRouterUrl":"xxx",
"nickName":"设备昵称",
"netType":"NET_WIFI",
"thingType":"DEVICE",
"status":1,
"nodeType":"DEVICE",
"description":"设备描述",
"propertyList":[
{
"identifier":"LightSwitch",
"name":"电源开关",
"value":"0",
"dataType":"BOOL",
"imageUrl":"",
"latestUpdateMillis":1588145461000
}
]
}
]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}