调用该接口获取用户绑定的设备列表信息。
路径 | /uc/listBindingByAccount |
版本号 | 1.0.8 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 8000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
thingType | String | 否 | DEVICE | 待查询设备的类型。取值为:VIRTUAL(表示虚拟设备);DEVICE(表示普通设备);WEB;APP。 |
nodeType | String | 否 | GATEWAY | 要查询的设备的节点类型。取值为:DEVICE(表示设备);GATEWAY(表示网关)。 |
pageNo | Int | 是 | 1 | 当前页码,从1开始。 |
pageSize | Int | 是 | 100 | 分页大小,大于等于1,小于等于100。 |
owned | Int | 否 | 0 | 绑定类型。取值为:0(表示被分享的设备);1(表示拥有的设备);null(表示所有的设备)。 |
groupId | String | 否 | value | 要查询的空间,如家ID、房间ID等。 |
isSubDevice | Boolean | 否 | true | 是否为子设备。归属在某一个网关设备下的设备表示为子设备。取值为:true (表示获取子设备列表);false (表示获取直连设备列表)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
total | Long |
满足条件的设备总数。 |
|
pageNo | Int |
分页页码。 |
|
pageSize | Int |
分页大小。 |
|
data | JSON |
设备的详情列表。 |
|
identityId | String |
用户的身份ID。 |
|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
deviceName | String |
设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。 |
|
productKey | String |
产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
|
productName | String |
设备所属产品的名称。 |
|
productImage | String |
设备所属产品的图标,如果未定义产品图标,该字段和categoryImage字段一致。 |
|
productModel | String |
设备所属产品的型号。 |
|
categoryImage | String |
设备所属产品品类的图标。 |
|
nickName | String |
设备的昵称,可为空。 |
|
netType | String |
产品下设备的联网方式,可取值: NET_LORA(表示LoRa);NET_CELLULAR(表示2G/3G/4G/5G蜂窝网);NET_WIFI(表示Wi-Fi);NET_ZIGBEE(表示ZigBee);NET_ETHERNET(表示以太网);NET_OTHER(表示其他网络类型)。 |
|
thingType | String |
设备的类型,根据在生活物联网平台创建设备的方式决定,一般正式量产的设备为DEVICE类型, 可取值: VIRTUAL(表示虚拟设备);VIRTUAL_SHADOW(表示虚拟影子设备);DEVICE(表示普通设备)。 |
|
status | Int |
设备状态。0(表示未激活);1(表示在线);3(表示离线);8(表示禁用)。 |
|
owned | Int |
设备和用户的关系,可取值:0(表示分享者),1(表示拥有者)。 |
|
nodeType | String |
设备的节点类型,可取值包括:DEVICE,GATEWAY。 |
|
identityAlias | String |
用户的显示名,mobile 或 loginName 或 email。 |
|
subDevice | Boolean |
标识是否为子设备,true(表示为子设备),false 或者 null(表示为直连设备)。 |
|
gmtModified | Long |
绑定设备的时间。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.8",
"iotToken": "token"
},
"params":{
"thingType": "DEVICE",
"nodeType": "GATEWAY",
"pageNo":1,
"pageSize":100,
"owned":0,
"groupId": "value",
"isSubDevice":true
}
}
正常返回示例
JSON
格式
{
"id":"4de2c367-c1db-417c-aa15-8c585e595d92",
"code":200,
"message":null,
"localizedMsg":null,
"data":{
"total":2,
"pageId":1,
"pageSize":10,
"data":[
{
"identityId":"xxx",
"iotId":"edwB6TqvOW2iXnmY7TNa000100",
"deviceName":"摄像头1",
"productKey":"产品 pk",
"productName":"产品名称",
"productImage":"产品图片",
"productModel":"产品型号",
"categoryKey":"Camera",
"categoryImage":"xxx",
"panelPageRouterUrl":"xxx",
"nickName":"设备昵称",
"netType":"NET_WIFI",
"thingType":"DEVICE",
"status":1,
"owned":1,
"nodeType":"DEVICE",
"identityAlias":"133xxx",
"isSubDevice":false,
"gmtModified":"xxx"
},
{
"identityId":"xxx",
"iotId":"xadqskpHGoswW8loL89h000100",
"deviceName":"摄像头2",
"productKey":"产品 pk",
"productName":"产品名称",
"productImage":"产品图片",
"productModel":"产品型号",
"categoryKey":"Camera",
"categoryImage":"xxx",
"panelPageRouterUrl":"xxx",
"nickName":"设备昵称",
"netType":"NET_WIFI",
"thingType":"DEVICE",
"status":1,
"owned":1,
"nodeType":"DEVICE",
"identityAlias":"133xxx",
"isSubDevice":false,
"gmtModified":"xxx"
}
]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}