调用该接口获取家的全部设备下的元素(设备或者设备组)列表。

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

请求参数

名称 类型 是否必选 示例值 描述
homeId String 31b376376363401b95b10045f74**** 家的ID,生活物联网平台赋予家的唯一标识符。
propertyIdentifiers List ["LightSwitch","PowerSwitch","WorkSwitch"] 用于过滤产品TSL属性运行态数据的标识符identifier列表。
pageNo Int 1 分页页码,从1开始。
pageSize Int 20 每页显示的记录数。取值范围:1~20。
elementType String DEVICE, CONTROL_GROUP 元素的类型,可取值:DEVICE(表示设备);CONTROL_GROUP(表示控制组)。

返回数据

名称 类型 示例值 描述
code Int

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

message String

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

localizedMsg String

本地语言的错误信息。

data JSON

响应结果。

total Long

满足条件的元素总数,即总共有多少设备或多少控制组。

pageNo Int

分页页码。

pageSize Int

分页大小。

items JSON

元素详情列表。

elementType String

元素类型。 DEVICE(表示设备),CONTROL_GROUP(表示控制组)。

elementId String

元素的ID,生活物联网平台赋予该元素的唯一标识符。

name String

元素的名称。

roomId String

当elementType为DEVICE时,返回的设备所在房间的ID。

roomName String

当elementType为DEVICE时,返回的设备所在房间的名称。

productKey String

元素所属产品的Key。

productName String

元素所属产品的名称。

productModel String

当elementType为DEVICE时,返回的设备所属产品的型号。

categoryKey String

当elementType为DEVICE时,返回的设备所属产品的品类key,即产品的CategoryKey。

categoryImage String

当elementType为DEVICE时,返回的设备所属产品的品类图标。

panelPageRouterUrl String

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

nickName String

当elementType为DEVICE时,返回的设备昵称或别名。

netType String

当elementType为DEVICE时,返回的设备入网类型。

thingType String

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

status Int

当elementType为DEVICE时,返回的设备的状态。0(未激活);1(在线);3(离线);8(禁用)。

nodeType String

当elementType为DEVICE时,返回的设备节点类型。DEVICE(表示设备); GATEWAY(表示网关)。

description String

当elementType为DEVICE时,返回设备的描述。

propertyList JSON

元素的TSL属性状态列表。

identifier String

物模型属性的标识符。

name String

物模型属性的名称。

value String

物模型属性当前状态值。

dataType String

物模型属性值的数据类型。

imageUrl String

物模型属性的图标 URL。

latestUpdateMillis Long

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

productImage String

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

deviceCnt Int

当elementType为CONTROL_GROUP时,返回的归属于设备组的设备总数。

deviceOnlineCnt Int

当elementType为CONTROL_GROUP时,返回的归属于设备组的在线设备总数。

masterDeviceIotId String

当elementType为CONTROL_GROUP时,返回的设备组主控设备的IotId。

controlGroupStatus String

当elementType为CONTROL_GROUP时,返回的设备组状态。包括NORMAL(表示设备组状态正常);INVALID(表示设备组处于无效状态,当设备组下的设备全部离线,或者控制组下设备数量 <= 1时,设备组的状态为INVALID)。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.4",
		"iotToken": "token"
	},
	"params":{
		"homeId": "31b376376363401b95b10045f74****",
		"propertyIdentifiers":[
			"LightSwitch",
			"PowerSwitch",
			"WorkSwitch"
		],
		"pageNo":1,
		"pageSize":20,
		"elementType": "DEVICE, CONTROL_GROUP"
	}
}

正常返回示例

JSON 格式

{
    "code":200,
    "message":"success",
    "localizedMsg":"",
    "data":{
        "total":2,
        "pageNo":1,
        "pageSize":10,
        "data":[
            {
                "elementType":"DEVICE",
                "elementId":"edwB6TqvOW2iXnmY7TNa000100",
                "deviceName":"摄像头1",
                "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
                    }
                ]
            },
            {
                "elementType":"GROUP",
                "elementId":"bc04e8c1d489451284f59a5eb696e6a5",
                "masterDeviceIotId":"edwB6TqvOW2iXnmY7TNa000100",
                "name":"摄像头组",
                "productKey":"产品 pk",
                "productImage":"产品图片 URL",
                "controlGroupStatus":"NORMAL",
                "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
}