调用该接口获取家下设备组内的设备列表。

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

请求参数

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

返回数据

名称 类型 示例值 描述
code Int

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

message String

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

localizedMsg String

本地语言的错误信息。

data JSON

响应结果。

total Long

满足条件的设备总数。

items JSON

设备的详情列表。

iotId String

设备的ID,生活物联网平台赋予设备的唯一标识符。

deviceName String

设备的名称。

productKey String

设备所属产品的ProductKey。

productName String

设备所属产品的名称。

productImage String

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

productModel String

设备所属产品产品的型号。

categoryKey String

设备所属产品的品类key,即产品的CategoryKey。

categoryImage String

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

nickName String

设备的昵称或别名。

netType String

设备入网类型。

thingType String

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

status Int

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

nodeType String

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

description String

设备的描述。

propertyList JSON

设备的TSL属性状态列表。

identifier String

物模型属性的标识符。

name String

物模型属性的名称。

dataType String

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

value String

物模型属性当前状态值。

imageUrl String

物模型属性的图标 URL。

latestUpdateMillis Long

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

roomId String

设备所在房间的ID。

roomName String

设备所在房间的名称。

panelPageRouterUrl String

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

pageNo Int

分页页码。

pageSize Int

分页大小。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.3",
		"iotToken": "token"
	},
	"params":{
		"homeId": "9f2ca71c99d440018b55ac530987****",
		"controlGroupId": "9f2ca71c99d440018b55ac530987****",
		"pageNo":1,
		"pageSize":20,
		"propertyIdentifiers":[
			"PowerSwitch",
			"LightSwitch",
			"WorkSwitch"
		]
	}
}

正常返回示例

JSON 格式

{
    "id":"4de2c367-c1db-417c-aa15-8c585e595d92",
    "code":200,
    "message":null,
    "localizedMsg":null,
    "data":{
        "total":1,
        "pageNo":1,
        "pageSize":10,
        "items":[
            {
                "iotId":"xxx1",
                "deviceName":"摄像头1",
                "roomId":"xxx",
                "roomName":"xxx",
                "productKey":"产品 pk",
                "productName":"产品名称",
                "productImage":"产品图片",
                "productModel":"产品型号",
                "categoryKey":"Camera",
                "categoryImage":"xxx",
                "nickName":"设备昵称",
                "netType":"",
                "thingType":"APP",
                "status":1,
                "nodeType":"DEVICE",
                "description":"xxx",
                "propertyList":[
                    {
                        "identifier":"LightSwitch",
                        "name":"xx",
                        "value":"xx",
                        "dataType":"xx",
                        "imageUrl":"xx",
                        "latestUpdateMillis":1588145461000
                    }
                ]
            }
        ]
    }
}

异常返回示例

JSON 格式

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