调用该接口,根据设备ID,获取设备和用户的绑定关系。
路径 | /uc/listBindingByDev |
版本号 | 1.0.6 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | 要查询的目标设备ID。设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 | |
pageNo | Int | 是 | 1 | 当前页号,从1开始的页序号。 |
pageSize | Int | 是 | 100 | 分页大小,大于等于1,小于等于100。 |
owned | Int | 否 | 绑定类型。取值为:0(表示被分享的设备);1(表示拥有的设备);null(表示所有的设备)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
total | Int |
云端的总数。 |
|
pageNo | Int |
当前页号。 |
|
pageSize | Int |
分页大小。 |
|
data | JSON |
用户绑定设备列表。 |
|
identityId | String |
用户的身份ID。 |
|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
productKey | String |
产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
|
deviceName | String |
设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。 |
|
productName | String |
设备所属产品的名称。 |
|
productImage | String |
设备所属产品的图片。 |
|
productModel | String |
设备所属产品的型号。 |
|
categoryImage | String |
品类图标。 |
|
nickName | String |
设备的昵称或别名,通过setDeviceNickName设置。 |
|
netType | String |
设备入网类型。 |
|
thingType | String |
设备的类型,根据在生活物联网平台创建设备的方式决定,一般正式量产的设备为DEVICE类型, 可取值: VIRTUAL(表示虚拟设备);VIRTUAL_SHADOW(表示虚拟影子设备);DEVICE(表示普通设备)。 |
|
nodeType | Int |
节点类型:0(表示DEVICE);1(表示GATEWAY)。 |
|
status | Int |
设备状态。0(表示未激活);1(表示在线);3(表示离线);8(表示禁用)。 |
|
owned | Int |
用户的类型。 0(表示分享者);1(表示拥有者)。 |
|
identityAlias | String |
用户的显示名:mobile,loginName或email。 |
|
gmtModified | Long |
修改绑定的时间。 |
|
description | String |
相关描述。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.6",
"iotToken": "token"
},
"params":{
"iotId": "value0",
"pageNo":1,
"pageSize":100,
"owned": "value3"
}
}
正常返回示例
JSON
格式
{
"code": 200,
"data": [
{
"productModel": "testProduct",
"iotId": "fy2Z1oZFxxxxxxx00101edf00",
"netType": "NET_WIFI",
"identityId": "5082opabf5192xxxxxxxx980ae6f6093",
"thingType": "DEVICE",
"nodeType": "DEVICE",
"productKey": "a1xxxxJNb",
"deviceName": "b65cb59xxxxxxxx08592cd695fb",
"productName": "0dxxxx95",
"status": 3
}
],
"id": "e2d74ffe-308e-xxxx-xxxx-9b44a43eabc9"
}
异常返回示例
JSON
格式
{
"code":2064,
"id":"4fa207ca-fffd-xxxx-xxxx-e6f7ca6c99c3",
"localizedMsg":"请求错误",
"message":"need authorize to bind"
}