接入服务概述¶
接入服务接口提供对产品、设备、命令的管理操作。详细信息,参考以下 API 文档。有关设备管理的更多信息,参见 连接与资产管理服务。
接入服务中的接口是一些 EnOS™ 开放涵盖系统各个核心业务流程的 Open API 接口。有关 EnOS API 和 EnOS 提供的接口详细信息,参见 有关 EnOS API。
有关如何调用 EnOS API 的信息,参见 EnOS API 快速入门。
产品¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Create Product | 创建产品 | √ | × |
Delete Product | 删除产品 | √ | × |
Get Product | 获取产品的详细信息 | √ | × |
Search Product | 搜索满足条件的产品 | √ | × |
Update Product | 更新产品 | √ | × |
设备¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Create Device | 创建设备 | √ | × |
Batch Create Devices | 批量创建设备 | √ | × |
Delete Device | 删除设备 | √ | × |
Disable Device | 禁用设备 | √ | × |
Enable Device | 启用设备 | √ | × |
Get Device | 获取设备信息 | √ | √ |
Replace Device | 更换设备 | √ | × |
Search Device | 查询设备信息 | √ | × |
Update Device | 更新设备 | √ | × |
证书¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Apply Certificate | 申请证书并绑定证书到指定的设备上 | √ | × |
Renew Certificate | 更新证书,并将新证书与设备进行绑定 | √ | × |
Revoke Certificate | 撤销设备绑定的证书 | √ | × |
List Certificate | 显示设备绑定的证书列表 | √ | × |
网关与子设备¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Add Sub-Device | 给网关设备添加新的子设备 | √ | × |
Get Gateway | 获取子设备对应的网关信息 | √ | × |
Remove Sub-Device | 将子设备从网关下移除 | √ | × |
Search Sub-Device | 搜索网关下的子设备信息 | √ | × |
设备数据¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Cancel Command | 取消缓存命令的接口 | √ | × |
Get Command | 获取单个命令信息 | √ | × |
Get Event | 通过 eventId 获取 Event 的详细信息 |
√ | × |
Invoke Service | 向设备下发服务调用接口 | √ | × |
Search Command | 按照筛选条件查询云端向设备发送的指令信息 | √ | × |
Search Event | 按条件分页搜索事件 | √ | × |
Set Measurepoint | 测点设置接口 | √ | √ |
Get File | 获取文件的信息 | √ | × |
Download File | 下载某个设备上传的文件 | √ | × |
Delete File | 删除某个设备上传的文件 | √ | × |
HTTP 消息集成¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Upload Attribute | 上传设备的属性数据,包括文件类型的属性数据 | √ | × |
Upload Events | 上传设备的事件数据,包括文件类型的事件数据 | √ | × |
Upload Measurement Points | 上传设备的测点数据,包括文件类型的测点数据 | √ | × |
固件管理¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Create Firmware File | 为一个产品创建固件 | √ | × |
Get Firmware File | 获取指定固件版本号的固件详情 | √ | × |
List Device Current Firmware | 罗列某产品下所有设备的固件版本 | √ | × |
Search Firmware File | 按条件查询一个 OU 下的固件信息 | √ | × |
Search Device Upgrade | 查询设备的固件信息及升级状态 | √ | × |
Delete Firmware | 删除一个指定的固件 | √ | × |
固件 OTA 升级任务管理¶
操作名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Create OTA Job | 创建批量的固件 OTA 验证或升级任务 | √ | × |
Get OTA Job | 查询一个固件 OTA 升级 job 详情 | √ | × |
Search OTA Job | 搜索 OTA job 信息 | √ | × |
Search OTA Task | 搜索设备执行的某个 OTA 任务的详情及执行进度、状态 | √ | × |
Start OTA Job | 启动一个 OTA job | √ | × |
Stop OTA Job | 停止一个 OTA job | √ | × |
Delete OTA Job | 删除一个 OTA job | √ | × |
Cancel OTA Task | 取消 OTA job 中指定的某个设备的 OTA 升级 task | √ | × |
Retry OTA Task | 重试 OTA job 中指定的某个设备的 OTA 升级 task | √ | × |