网关与子设备
大约 2 分钟
网关与子设备
网关设备(节点类型为网关)下可挂载子设备,本组接口管理网关与子设备的绑定关系。
批量绑定子设备
| POST | /admin-api/iot/device-relation/create |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| parentDeviceId | 网关设备id | json | true | long |
| deviceIds | 子设备id,多个以英文逗号分隔的字符串,如 "101,102,103" | json | true | string |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 绑定成功返回true | boolean |
| msg | 状态消息 | string |
查询子设备关系分页
| GET | /admin-api/iot/device-relation/page |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| pageNo | 页码,从 1 开始,示例值(1) | query | false | int32 |
| pageSize | 每页条数,最大值为 1000,示例值(10) | query | false | int32 |
| parentDeviceId | 网关设备id | query | false | long |
| deviceId | 子设备id | query | false | long |
| createTime | 创建时间时间范围 | query | false | array[datetime] |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 分页数据 | object |
| ---total | 返回结果条数 | int |
| ---list | 返回数据列表 | array |
| ------id | 关联记录id | long |
| ------parentDeviceId | 网关设备id | long |
| ------deviceId | 子设备id | long |
| ------deviceName | 子设备名称(服务端填充) | string |
| ------productName | 子设备产品名称(服务端填充) | string |
| ------deviceState | 子设备状态;-1:未激活;0:离线;1:在线 | int |
| ------createTime | 创建时间 | string |
| msg | 状态消息 | string |
删除绑定关系
| DELETE | /admin-api/iot/device-relation/delete |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| id | 关联记录id(删除单个子设备绑定) | query | true | long |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 删除成功返回true | boolean |
| msg | 状态消息 | string |
提示
该组接口没有更新接口:调整绑定关系通过删除后重新创建实现。删除设备时,其网关-子设备关联会被级联清理。