设备预配置服务 API 概述¶
设备预配置的接口提供设备预配置中的设备的管理操作。有关设备预配置的信息,参见 设备预配置。
前提条件¶
确保已阅读设备预配置的使用限制。参见 使用限制。
API 列表¶
设备预配置中的 API 可按调用对象分为两类:
应用 API:属于 EnOS 面向开发者开放的 API 接口,基于这些接口,开发者可以访问系统内的资源,开发各类应用。调用应用 API,需要 获取网关地址,授权服务账号,以及准备开发环境。
设备 API:是设备预配置服务面向设备提供的 API 接口。基于这些接口,设备可以直接完成自注册,并获取自身认证信息。设备 API 使用特殊的网关地址,调用时不需要使用服务账号和准备环境。更多信息,参见 有关设备 API。
应用 API 列表¶
以下为设备预配置服务应用 API 列表。“√” 和 “×” 表示是否适用于 EnOS Cloud 或 EnOS Edge。
部分应用 API 在原有版本的基础上新增 V2.5 版本。有关 V2.5 版本的变更内容,参见 EnOS 2.4 CU2。
API 名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
---|---|---|---|---|
创建 DPS 设备 |
|
√ |
× |
|
获取 DPS 设备信息 |
|
√ |
× |
|
分配与激活 DPS 设备 |
|
√ |
× |
|
重置设备的分配状态 |
|
√ |
× |
|
搜索满足条件的 DPS 设备 |
/dps-service/v2.5/pvs/device?action=search |
√ |
× |
|
删除 DPS 设备 |
/dps-service/v2.5/pvs/device?action=delete |
√ |
× |
|
更新 DPS 设备信息 |
/dps-service/v2.5/pvs/device?action=update |
√ |
× |
|
替换 DPS 设备 |
/dps-service/v2.5/pvs/device?action=replace |
√ |
× |
设备 API 列表¶
以下为设备预配置服务设备 API 列表。“√” 和 “×” 表示是否适用于 EnOS Cloud 或 EnOS Edge。
API 名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
---|---|---|---|---|
获取设备三元组信息和协议地址 |
/dev/get/conn |
√ |
× |
|
直连设备获取自身三元组信息和协议地址,并完成注册 |
/dev/bootstrap |
√ |
× |