查询、改名与解绑设备
查询、改名与解绑设备
查询、修改名称、解绑都是 HTTP 接口。请求与返回字段以各链接的 OpenAPI 方法页为准。建议走后台调用,见 应用开发:设备绑定/解绑、设备管理建议通过后台服务调用开放平台 HTTP 接口。绑定成功后获取设备列表,该页写调用 设备查询 中的相关接口。
设备查询说明 写本模块包含设备在线情况、绑定情况、设备详细信息、设备升级版本信息。升级状态和进度见 升级设备固件。
步骤
查询
接口说明以 设备查询说明 与各 OpenAPI 方法页为准。
- 分页查询。新接入调用 分页详情 device.detail.page。
page从 1 开始,pageSize范围为 1~50。source可选bind、share、bindAndShare,默认bindAndShare(不含终端用户托管设备)。托管设备用 authorizedDeviceList 或 listDeviceDetailsByIds(含托管来源)。返回中的deviceId、channelList用于后续调用;capabilityIds不要当作 get、set、invoke 的入参。仍在使用的 listDeviceDetailsByPage 只作为兼容接口。 - 按序列号批量查询。listDeviceDetailsByIds:批量查询设备详细信息。说明页描述:按设备查询列表,返回绑定、分享、托管的设备。功能详情:批量根据设备序列号,获取设备的详细信息。
- 在线状态。deviceOnline:可查未绑定设备及有权限设备的在离线;未绑定设备时结果仅表示设备本体(非 0 通道)状态。子账号 token 无需额外权限。
onLine:0 离线、1 在线、3 升级中、4 休眠(设备与通道均有)。 - 未绑定设备信息。unBindDeviceInfo:未绑定设备信息获取。功能详情:查询未绑定的设备信息。子账号 token 无需权限即可请求。返回字段中的配网方式说明见 在 App 内配网并绑定。
- 是否已绑定。checkDeviceBindOrNot:查询设备绑定情况。功能详情:查询设备绑定情况,是否被绑定,是否被当前账户绑定。子账号 token 无需权限即可请求。返回字段
isBind:是否被绑定到某个账号。isMine:是否属于当前账号。
改名
调用 modifyDeviceName:修改设备或通道名称。功能详情:
- 通道号为空时,设置设备名称;对于单通道设备,会同时修改设备下已存在的通道号的通道名称。
- 通道号不为空时,设置通道名称。
- 支持修改网关下关联的子设备的名称。修改子设备名称时,产品 id、子设备序列号必填,可从 分页详情 或 listDeviceDetailsByIds 取得。字段以对应接口页为准。
备注:修改乐橙分享的有权限的设备时,通道号必传,单通道 IPC 的设备名会同时修改。
名称的合法值说明最大字符长度为 64 位。子账号 token 请求所需最小权限"Permission":"Config","Resource":"cam:序列号:通道号"。返回 data 为无 data 数据返回。
解绑
调用 unBindDevice 解绑账号下设备。注意:
- 设备解绑后,报警消息立即删除。
- 云录像不会马上删除,而是过期自动删除。
- 设备解绑时已开通的云存储套餐会自动返回开发者账号下,可以继承给该账号下其他设备。
- 传
subDeviceId解绑子设备时,是解除子设备和上层网关设备deviceId的关联关系,网关设备不会解绑。
除上表外,unBindDevice 还支持下列可选参数(合法值均为 delete / retain;未传时按服务端默认,国内环境常见默认见下表)。完整字段见 unBindDevice 请求参数。
| 参数 | 未传时国内常见默认 | 含义 |
|---|---|---|
deleteCloudAlarms | 删报警消息 | 与注意 1 一致 |
deleteCloudStorage | 解绑并回退云存储套餐 | 与注意 3 一致 |
deleteCloudRecords | 保留云录像片段 | 与注意 2 一致;显式 delete 才会删片段 |
deleteDeviceLink | 删与 NVR 等物理链接 | 影响级联通道关系,集成方按需 retain |
解绑子设备时,产品 id、子设备序列号必填,可从 分页详情 或 listDeviceDetailsByIds 取得。返回 data 为无 data 数据返回。
设备维护说明 还列出封面刷新、验证设备密码、修改设备密码。这三项不在本页任务里,见该说明页。
各端实现
服务端 HTTP
查询、改名、解绑都由服务端调用上述 HTTP 接口。请求地址与参数表以各接口页为准。