接入服务概述¶
接入服务 API 提供对产品、设备、命令的管理操作。有关设备管理的更多信息,参见 设备连接与管理服务。
接入服务 API 属于 EnOS 开放涵盖系统各个核心业务流程的 Open API 接口。有关 EnOS API 和 EnOS 提供的接口详细信息,参见 有关 EnOS API。
有关如何调用 EnOS API 的信息,参见 EnOS API 快速入门。
API 列表¶
以下为接入服务 API 列表。“√” 和 “×” 表示适用于 EnOS Cloud 或 EnOS Edge。
产品¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Create Product | 创建产品 | /connect-service/v2.1/products?action=create | √ | × |
Delete Product | 删除产品 | /connect-service/v2.1/products?action=delete | √ | × |
Get Product | 获取产品的详细信息 |
|
√ | × |
Search Product | 搜索满足条件的产品 |
|
√ | × |
Update Product | 更新产品 | /connect-service/v2.1/products?action=update | √ | × |
设备¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Create Device | 创建设备 |
|
√ | × |
Batch Create Devices | 批量创建设备 |
|
√ | × |
Delete Device | 删除设备 | /connect-service/v2.1/devices?action=delete | √ | × |
Disable Device | 禁用设备 | /connect-service/v2.1/devices?action=disable | √ | × |
Enable Device | 启用设备 | /connect-service/v2.1/devices?action=enable | √ | × |
Get Device | 获取设备信息 |
|
√ | √ |
Replace Device | 更换设备 |
|
√ | × |
Search Device | 查询设备信息 |
|
√ | √ |
Update Device | 更新设备 | /connect-service/v2.1/devices?action=update | √ | × |
Get Device Statistics | 获取特定组织或产品下设备统计信息 | /connect-service/v2.1/devices?action=getStats | √ | × |
Report Device Firmware Version | 上报设备固件版本 | /connect-service/v2.5/devices?action=reportFirmwareVersion | √ | × |
Modify Device Status | 更新设备状态 | /connect-service/v2.4/devices?action=modifyDeviceStatus | √ | × |
设备组¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Add Device to Device Group | 添加设备至设备组 | /connect-service/v2.5/deviceGroups?action=addDeviceToDeviceGroup | √ | × |
Create Device Group | 批量创建设备组 | /connect-service/v2.5/deviceGroups?action=createGroup | √ | × |
Delete Device Group | 删除设备组 | /connect-service/v2.5/deviceGroups?action=deleteGroup | √ | × |
Get Device Group | 获取设备组 | /connect-service/v2.5/deviceGroups?action=getGroup | √ | × |
Remove Device from Device Group | 从设备组移除设备 | /connect-service/v2.5/deviceGroups?action=removeDeviceFromDeviceGroup | √ | × |
Search Device by Device Group | 通过设备组查询设备信息 | /connect-service/v2.5/deviceGroups?action=searchDeviceByDeviceGroup | √ | × |
Search Device Group by Device | 通过设备查询设备组信息 | /connect-service/v2.5/deviceGroups?action=searchDeviceGroupByDevice | √ | × |
Search Device Group | 查询设备组信息 | /v2.5/deviceGroups?action=searchGroup | √ | × |
Update Device Group | 更新设备组信息 | /connect-service/v2.5/deviceGroups?action=updateGroup | √ | × |
证书¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Apply Certificate | 申请证书并绑定证书到指定的设备上 | /connect-service/v2.0/certificates?action=apply | √ | × |
Renew Certificate | 更新证书,并将新证书与设备进行绑定 | /connect-service/v2.0/certificates?action=renew | √ | × |
Revoke Certificate | 撤销设备绑定的证书 | /connect-service/v2.0/certificates?action=revoke | √ | × |
List Certificate | 显示设备绑定的证书列表 | /connect-service/v2.0/certificates?action=list | √ | × |
网关与子设备¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Add Sub-Device | 给网关设备添加新的子设备 | /connect-service/v2.1/device-topos?action=addSubDevice | √ | × |
Get Gateway | 获取子设备对应的网关信息 |
|
√ | × |
Remove Sub-Device | 将子设备从网关下移除 | /connect-service/v2.1/device-topos?action=removeSubDevice | √ | × |
Search Sub-Device | 搜索网关下的子设备信息 |
|
√ | × |
设备数据¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Cancel Command | 取消缓存命令的接口 | /connect-service/v2.1/commands?action=cancel | √ | × |
Get Command | 获取单个命令信息 | /connect-service/v2.1/commands?action=get | √ | × |
Get Event | 通过 eventId 获取 Event 的详细信息 |
/connect-service/v2.1/events?action=get | √ | × |
Get Latest Measurement Points | 获取设备上传的最新测点数据 | /connect-service/v2.1/measurepoints?action=queryLatest | √ | √ |
Invoke Service | 向设备下发服务调用接口 | /connect-service/v2.1/commands?action=invokeService | √ | × |
Search Command | 按照筛选条件查询云端向设备发送的指令信息 | /connect-service/v2.1/commands?action=search | √ | × |
Search Event | 按条件分页搜索事件 | /connect-service/v2.1/events?action=search | √ | × |
Set Measurepoint | 测点设置接口 | /connect-service/v2.1/commands?action=setMeasurepoint | √ | √ |
Get File | 获取文件的信息 | /connect-service/v2.1/files?action=getFileInfo | √ | × |
Download File | 下载某个设备上传的文件 | /connect-service/v2.1/files?action=download | √ | × |
Delete File | 删除某个设备上传的文件 | /connect-service/v2.1/files?action=delete | √ | × |
Create Command Jobs | 创建 Command Job | /connect-service/v2.5/commands?action=createJob | √ | × |
Search Command Jobs | 按照筛选条件查询 Command Job。 | /connect-service/v2.5/commands?action=searchJob | √ | × |
Get Command Jobs | 查询 Command Job 详情。 | /connect-service/v2.5/commands?action=getJob | √ | × |
Delete Command Jobs | 删除 Command Job。 | /connect-service/v2.5/commands?action=deleteJob | √ | × |
Query Command Job Statistics | 查询 Command Job 的数据分析信息。 | /connect-service/v2.5/commands?action=queryStatistics | √ | × |
Get Command Tasks | 获取 Command Task。 | /connect-service//v2.5/commands?action=getTask | √ | × |
Search Command Tasks | 搜索Command Task的详情及执行进度、状态。 | /connect-service/v2.5/commands?action=searchTask | √ | × |
Retry Command Task | 重试 Command Task。 | /connect-service/v2.5/commands?action=retryTask | √ | × |
Cancel Command Tasks | 取消 Command Tasks。 | /connect-service/v2.5/commands?action=cancelTask | √ | × |
HTTP 消息集成¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Upload Attribute | 上传设备的属性数据,包括文件类型的属性数据 | /connect-service/v2.1/integration?action=postAttribute | √ | × |
Upload Events | 上传设备的事件数据,包括文件类型的事件数据 | /connect-service/v2.1/integration?action=postEvent | √ | × |
Upload Measurement Points | 上传设备的测点数据,包括文件类型的测点数据 | /connect-service/v2.1/integration?action=postMeasurepoint | √ | √ |
固件管理¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Create Firmware File | 为一个产品创建固件 | /connect-service/v2.1/ota-firmwares?action=create | √ | × |
Get Firmware File | 获取指定固件版本号的固件详情 | /connect-service/v2.1/ota-firmwares?action=get | √ | × |
List Device Current Firmware | 罗列某产品下所有设备的固件版本 | /connect-service/v2.1/ota-firmwares?action=listVersion | √ | × |
Search Firmware File | 按条件查询一个 OU 下的固件信息 | /connect-service/v2.1/ota-firmwares?action=search | √ | × |
Search Device Upgrade | 查询设备的固件信息及升级状态 | /connect-service/v2.1/ota-firmwares?action=searchDeviceUpgrade | √ | × |
Delete Firmware | 删除一个指定的固件 | /connect-service/v2.1/ota-firmwares?action=delete | √ | × |
固件 OTA 升级任务管理¶
操作名称 | 描述 | URL | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|
Create OTA Job | 创建批量的固件 OTA 验证或升级任务 | /connect-service/v2.1/ota-jobs?action=create | √ | × |
Get OTA Job | 查询一个固件 OTA 升级 job 详情 | /connect-service/v2.1/ota-jobs?action=get | √ | × |
Search OTA Job | 搜索 OTA job 信息 | /connect-service/v2.1/ota-jobs?action=search | √ | × |
Search OTA Task | 搜索设备执行的某个 OTA 任务的详情及执行进度、状态 | /connect-service/v2.1/ota-jobs?action=searchTask | √ | × |
Start OTA Job | 启动一个 OTA job | /connect-service/v2.1/ota-jobs?action=start | √ | × |
Stop OTA Job | 停止一个 OTA job | /connect-service/v2.1/ota-jobs?action=stop | √ | × |
Delete OTA Job | 删除一个 OTA job | /connect-service/v2.1/ota-jobs?action=delete | √ | × |
Cancel OTA Task | 取消 OTA job 中指定的某个设备的 OTA 升级 task | /connect-service/v2.1/ota-jobs?action=cancelTask | √ | × |
Retry OTA Task | 重试 OTA job 中指定的某个设备的 OTA 升级 task | /connect-service/v2.1/ota-jobs?action=retryTask | √ | × |
Download Firmware File | 下载固件文件 | /connect-service/v2.5/files?action=downloadFirmwareFile | √ | × |
API 版本¶
下表列出接入服务企业版与轻量版包含的 API 服务。
API 类别 | 企业版 | 轻量版 |
---|---|---|
产品 | √ | √ |
设备 | √ | √ |
证书 | √ | √ |
网关与子设备 | √ | √ |
设备数据 | √ | √ |
HTTP 消息集成 | √ | √ |
固件管理 | √ | √ |
固件 OTA 升级任务管理 | √ | √ |
解密 Product/Device Secret¶
通过 V2.4 API 获取 product secret 和 device secret 时,product/device secret 将通过加密处理。如何解密,参见 解密 Product/Device Secret。