接入服务 API 概述¶
设备连接与管理可以帮助你快速建立设备与 EnOS Cloud 之间的快速安全通信，并实现从计划到退役阶段的设备全生命周期管理。
通过接入服务 API， 设备接入和管理人员可以创建、管理产品和设备，管理设备证书、设备固件，以及远程下发命令等。关于接入服务 API 的完整接口列表及功能说明，参见 API 列表。
前提条件¶
确保已获取服务账号，且服务账号拥有调用该 API 的权限。更多信息，参见 获取 API 调用权限。
确保已阅读设备连接与管理的 使用限制。
API 列表
¶
以下为接入服务 API 列表。“√” 和 “×” 表示适用于 EnOS Cloud 或 EnOS Edge。
部分 API 在原有版本的基础上新增 V2.4 版本，新旧版本同时支持使用。
产品¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建产品 |
/connect-service/v2.1/products?action=create |
√ |
× |
|
删除产品 |
/connect-service/v2.1/products?action=delete |
√ |
× |
|
获取产品的详细信息 |
|
√ |
× |
|
搜索满足条件的产品 |
|
√ |
× |
|
更新产品 |
/connect-service/v2.1/products?action=update |
√ |
× |
设备¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建设备 |
|
√ |
× |
|
批量创建设备 |
|
√ |
× |
|
删除设备 |
/connect-service/v2.1/devices?action=delete |
√ |
× |
|
禁用设备 |
/connect-service/v2.1/devices?action=disable |
√ |
× |
|
启用设备 |
/connect-service/v2.1/devices?action=enable |
√ |
× |
|
获取设备信息 |
|
√ |
√ |
|
更换设备 |
|
√ |
× |
|
查询设备信息 |
|
√ |
√ |
|
更新设备 |
/connect-service/v2.1/devices?action=update |
√ |
× |
|
获取特定组织或产品下设备统计信息 |
/connect-service/v2.1/devices?action=getStats |
√ |
× |
|
上报设备固件版本 |
/connect-service/v2.5/devices?action=reportFirmwareVersion |
√ |
× |
|
更新设备状态 |
/connect-service/v2.4/devices?action=modifyDeviceStatus |
√ |
× |
证书¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
申请证书并绑定证书到指定的设备上 |
/connect-service/v2.0/certificates?action=apply |
√ |
× |
|
更新证书，并将新证书与设备进行绑定 |
/connect-service/v2.0/certificates?action=renew |
√ |
× |
|
撤销设备绑定的证书 |
/connect-service/v2.0/certificates?action=revoke |
√ |
× |
|
显示设备绑定的证书列表 |
/connect-service/v2.0/certificates?action=list |
√ |
× |
网关与子设备¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
给网关设备添加新的子设备 |
/connect-service/v2.1/device-topos?action=addSubDevice |
√ |
× |
|
获取子设备对应的网关信息 |
|
√ |
× |
|
将子设备从网关下移除 |
/connect-service/v2.1/device-topos?action=removeSubDevice |
√ |
× |
|
搜索网关下的子设备信息 |
|
√ |
× |
设备数据¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
取消缓存命令的接口 |
/connect-service/v2.1/commands?action=cancel |
√ |
× |
|
获取单个命令信息 |
/connect-service/v2.1/commands?action=get |
√ |
× |
|
获取设备上传的最新测点数据 |
/connect-service/v2.1/measurepoints?action=queryLatest |
√ |
√ |
|
向设备下发服务调用接口 |
/connect-service/v2.1/commands?action=invokeService |
√ |
× |
|
按照筛选条件查询云端向设备发送的指令信息 |
/connect-service/v2.1/commands?action=search |
√ |
× |
|
测点设置接口 |
/connect-service/v2.1/commands?action=setMeasurepoint |
√ |
√ |
|
获取文件的信息 |
/connect-service/v2.1/files?action=getFileInfo |
√ |
× |
|
下载某个设备上传的文件 |
/connect-service/v2.1/files?action=download |
√ |
× |
|
删除某个设备上传的文件 |
/connect-service/v2.1/files?action=delete |
√ |
× |
|
创建对一批设备下发命令的任务 |
/connect-service/v2.5/commands?action=createJob |
√ |
× |
|
按照筛选条件查询对一批设备下发命令的任务 |
/connect-service/v2.5/commands?action=searchJob |
√ |
× |
|
查询一批设备下发命令的任务的详情 |
/connect-service/v2.5/commands?action=getJob |
√ |
× |
|
删除一批设备下发命令的任务 |
/connect-service/v2.5/commands?action=deleteJob |
√ |
× |
|
查询一批设备下发命令的任务的数据分析信息 |
/connect-service/v2.5/commands?action=queryStatistics |
√ |
× |
|
获取一个设备下发命令的任务 |
/connect-service//v2.5/commands?action=getTask |
√ |
× |
|
搜索一个设备下发命令的任务的详情及执行进度、状态 |
/connect-service/v2.5/commands?action=searchTask |
√ |
× |
|
重试一个设备下发命令的任务 |
/connect-service/v2.5/commands?action=retryTask |
√ |
× |
|
取消一个设备下发命令的任务 |
/connect-service/v2.5/commands?action=cancelTask |
√ |
× |
HTTP 消息集成¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
上传设备的属性数据，包括文件类型的属性数据 |
/connect-service/v2.1/integration?action=postAttribute |
√ |
× |
|
上传设备的测点数据，包括文件类型的测点数据 |
/connect-service/v2.1/integration?action=postMeasurepoint |
√ |
√ |
固件管理¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
为一个产品创建固件 |
/connect-service/v2.1/ota-firmwares?action=create |
√ |
× |
|
获取指定固件版本号的固件详情 |
/connect-service/v2.1/ota-firmwares?action=get |
√ |
× |
|
罗列某产品下所有设备的固件版本 |
/connect-service/v2.1/ota-firmwares?action=listVersion |
√ |
× |
|
按条件查询一个 OU 下的固件信息 |
/connect-service/v2.1/ota-firmwares?action=search |
√ |
× |
|
查询设备的固件信息及升级状态 |
/connect-service/v2.1/ota-firmwares?action=searchDeviceUpgrade |
√ |
× |
|
删除一个指定的固件 |
/connect-service/v2.1/ota-firmwares?action=delete |
√ |
× |
|
下载固件文件 |
/connect-service/v2.5/files?action=downloadFirmwareFile |
√ |
× |
固件 OTA 升级任务管理¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|---|
创建批量的固件 OTA 验证或升级任务 |
/connect-service/v2.1/ota-jobs?action=create |
√ |
× |
|
查询批量的固件 OTA 升级任务详情 |
/connect-service/v2.1/ota-jobs?action=get |
√ |
× |
|
搜索批量的固件 OTA 升级任务信息 |
/connect-service/v2.1/ota-jobs?action=search |
√ |
× |
|
搜索设备执行的某个 OTA 任务的详情及执行进度、状态 |
/connect-service/v2.1/ota-jobs?action=searchTask |
√ |
× |
|
启动批量的固件 OTA 升级任务 |
/connect-service/v2.1/ota-jobs?action=start |
√ |
× |
|
停止批量的固件 OTA 升级任务 |
/connect-service/v2.1/ota-jobs?action=stop |
√ |
× |
|
删除批量的固件 OTA 升级任务 |
/connect-service/v2.1/ota-jobs?action=delete |
√ |
× |
|
取消一个设备的 OTA 升级任务 |
/connect-service/v2.1/ota-jobs?action=cancelTask |
√ |
× |
|
重试一个设备的 OTA 升级任务 |
/connect-service/v2.1/ota-jobs?action=retryTask |
√ |
× |
解密 Product/Device Secret¶
通过 V2.4 API 获取 product secret 和 device secret 时，product/device secret 将通过加密处理。如何解密，参见 解密 Product/Device Secret。
SDK 示例¶
你可以在 Github 上获取接入服务的 SDK 示例：