调用该接口查询网关下的子设备与C端用户的绑定关系。
路径 | /living/device/subdevice/query |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 10000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 否 | aD12ef8KkW YrT19EiNJJ 001082**** | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
productKey | String | 否 | a1UUZI**** | 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
deviceName | String | 否 | light | 设备的名称。 |
pageNo | Int | 是 | 1 | 分页页号,即从1开始当前页的序号。 |
pageSize | Int | 是 | 10 | 分页大小。取值范围:1~20。 |
lang | String | 是 | zh-CN | 语言类型,取值为:zh-CN(表示中文); en-US(表示英文)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | JSON |
响应的结果。 |
|
total | Long |
子设备总数目。 |
|
pageSize | Int |
分页大小。取值范围:1~20。 |
|
pageNo | Int |
分页页号,即从1开始当前页的序号。 |
|
data | JSON |
子设备数组。 |
|
iotId | String |
设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
|
deviceName | String |
设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。 |
|
productKey | String |
产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。 |
|
bound | Int |
绑定状态,0(表示未绑定);1(表示已绑定)。 |
|
status | Int |
设备状态。0(表示未激活);1(表示在线);3(表示离线);8(表示禁用)。 |
|
nickName | String |
设备的昵称或别名。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0",
"iotToken": "token"
},
"params":{
"iotId": "aD12ef8KkW YrT19EiNJJ 001082****",
"productKey": "a1UUZI****",
"deviceName": "light",
"pageNo":1,
"pageSize":10,
"lang": "zh-CN"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "xxxx"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}