调用该接口获取房间的设备列表。

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

请求参数

名称 类型 是否必选 示例值 描述
pageNo Int 分页页码,从 1 开始。
pageSize Int 分页大小,取值范围: 1~20。
propertyIdentifiers List 用于过滤产品TSL属性运行态数据的标识符identifier列表。
homeId String 家的ID,生活物联网平台赋予家的唯一标识符。
roomId String 房间的ID,生活物联网平台赋予房间的唯一标识符。

返回数据

名称 类型 示例值 描述
code Int

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

message String

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

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

total Long

满足条件的设备总数。

pageNo Int

分页页码。

pageSize Int

分页大小。

items JSON

满足条件的设备详情。

iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

deviceName String

设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。

productKey String

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

categoryKey String

设备所属产品的品类。

categoryImage String

设备所属产品的品类图标。

netType String

设备入网类型。

status Int

设备的状态。0(未激活);1(在线);3(离线);8(禁用)。

nodeType String

设备节点类型。DEVICE(表示设备); GATEWAY(表示网关)。

propertyList JSON

设备的TSL属性状态列表。

identifier String

物模型属性的标识符。

name String

物模型属性的名称。

dataType String

物模型属性值的类型。

value String

物模型属性当前状态值。

imageUrl String

物模型属性的图标URL。

latestUpdateMillis Long

物模型属性状态的最后一次上报时间,格式为UNIX时间戳,单位为毫秒(US)。

thingType String

设备类型。VIRTUAL(表示虚拟设备);WEB(表示IoT Studio配置化的Web应用);APP(表示应用App);DEVICE(表示实际设备)。

productName String

设备所属产品的名称。

productImage String

设备所属产品的图标,如果未定义产品图标,该字段和categoryImage 字段一致。

productModel String

设备所属产品的型号。

panelPageRouterUrl String

当categroyKey为Camera时返回该参数,是该设备所属产品的控制面板路由URL。

nickName String

设备的昵称或别名。

description String

设备的描述。

homeId String

设备所在家的ID。

homeName String

设备所在家的名称。

roomId String

设备所在房间的ID。

roomName String

设备所在房间的名称。

示例

请求示例

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

正常返回示例

JSON 格式

{
    "id":"4de2c367-c1db-417c-aa15-8c585e595d92",
    "code":200,
    "message":"success",
    "localizedMsg":"",
    "data":{
        "total":1,
        "pageNo":1,
        "pageSize":10,
        "items":[
            {
                "iotId":"edwB6TqvOW2iXnmY7TNa000100",
                "deviceName":"摄像头1",
                "homeId":"50f5op1556f65de314b983fd5bca4f2f2810****",
                "homeName":"我的家",
                "roomId":"50f5op1556f65de314b983fd5bca4f2f2810****",
                "roomName":"Xbox 游戏室",
                "productKey":"产品 pk",
                "productName":"产品名称",
                "productImage":"产品图片 URL",
                "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
}