CLI命令参考(V2)
边缘数据源配置管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建数据源配置 | hcloud IoTEdge CreateDs/v2 | 用户通过Console接口在指定边缘节点上创建数据源配置 | |
| 查询数据源配置列表 | hcloud IoTEdge BatchListDcDs/v2 | 查询数据源配置列表 | |
| 修改数据源配置 | hcloud IoTEdge UpdateDcDs/v2 | 修改数据源配置 | |
| 查询数据源配置 | hcloud IoTEdge ShowDcDs/v2 | 查询数据源配置 | |
| 删除数据源配置 | hcloud IoTEdge DeleteDcDs/v2 | 删除数据源配置 | |
| 下发数采配置 | hcloud IoTEdge SynchronizeDcConfigs/v2 | 下发数采配置 |
边缘数据源点位配置管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询数采连接子设备列表 | hcloud IoTEdge BatchListDcDevices/v2 | 查询数采连接下子设备列表 | |
| 创建点位表配置 | hcloud IoTEdge CreateDcPoint/v2 | 用户通过Console接口在指定边缘节点上创建点位表配置 | |
| 查询点位表配置列表 | hcloud IoTEdge BatchListDcPoints/v2 | 查询点位表配置列表 | |
| 修改点位表配置 | hcloud IoTEdge UpdateDcPoint/v2 | 修改点位表配置 | |
| 查询点位表配置详情 | hcloud IoTEdge ShowDcPoint/v2 | 查询点位表配置详情 | |
| 删除点位表配置 | hcloud IoTEdge DeleteDcPoint/v2 | 删除点位表配置 | |
| 批量删除点位表配置 | hcloud IoTEdge DeleteDcPoints/v2 | 批量删除点位表配置 |
点位表模板管理
应用管理
应用版本管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建应用版本 | hcloud IoTEdge CreateEdgeApplicationVersion/v2 | 创建应用版本 | |
| 查询应用版本列表 | hcloud IoTEdge BatchListEdgeAppVersions/v2 | 查询应用版本列表 | |
| 查询应用版本详情 | hcloud IoTEdge ShowEdgeApplicationVersion/v2 | 查询应用版本详情 | |
| 删除应用版本 | hcloud IoTEdge DeleteEdgeApplicationVersion/v2 | 删除应用版本 | |
| 修改应用版本 | hcloud IoTEdge UpdateEdgeApplicationVersion/v2 | 修改应用版本 | |
| 更新应用版本状态 | hcloud IoTEdge UpdateEdgeApplicationVersionState/v2 | 更新应用版本状态 |
边缘应用配置模板管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询应用配置模板列表 | hcloud IoTEdge BatchListAppConfigsTemplates/v2 | 查询应用配置模板列表 | |
| 添加应用配置模板 | hcloud IoTEdge AddAppConfigsTemplates/v2 | 添加应用配置模板 | |
| 查询应用配置模板详情 | hcloud IoTEdge ShowAppConfigsTemplate/v2 | 查询应用配置模板详情 | |
| 删除应用配置模板 | hcloud IoTEdge DeleteAppConfigsTemplate/v2 | 删除应用配置模板 | |
| 导入标准应用配置模板 | hcloud IoTEdge AddGeneralAppConfigsTemplate/v2 | 导入标准应用配置模板 |
模块影子管理
节点管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建边缘节点 | hcloud IoTEdge CreateEdgeNode/v2 | 创建边缘节点 | |
| 查询边缘节点列表 | hcloud IoTEdge ListEdgeNodes/v2 | 查询边缘节点列表 | |
| 查询边缘节点详情 | hcloud IoTEdge ShowEdgeNode/v2 | 查询边缘节点详情 | |
| 删除边缘节点 | hcloud IoTEdge DeleteEdgeNode/v2 | 删除指定边缘节点 | |
| 修改边缘节点 | hcloud IoTEdge UpdateEdgeNode/v2 | 修改边缘节点 | |
| 生成边缘节点安装命令 | hcloud IoTEdge CreateInstallCmd/v2 | 生成边缘节点安装命令,命令有效时间30分钟,超过后需要重新生成 | |
| 生成边缘节点重新安装命令 | hcloud IoTEdge CreateReinstallCmd/v2 | 生成边缘节点重新安装命令,命令有效时间30分钟,超过后需要重新生成 | |
| 生成边缘节点升级命令 | hcloud IoTEdge CreateUpgradeCmd/v2 | 生成边缘节点升级命令,命令有效时间30分钟,超过后需要重新生成 | |
| 查询边缘节点下的主机详情 | hcloud IoTEdge ShowEdgeNodeHostsInfo/v2 | 查询边缘节点下的主机详情 |
模块管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建边缘模块 | hcloud IoTEdge CreateModule/v2 | 用户通过Console接口在指定边缘节点上创建边缘模块 | |
| 查询边缘模块列表 | hcloud IoTEdge BatchListModules/v2 | 用户通过Console接口查询指定边缘节点上边缘模块列表 | |
| 删除边缘模块 | hcloud IoTEdge DeleteModule/v2 | 用户通过Console接口在指定边缘节点上删除边缘模块 | |
| 查询边缘模块 | hcloud IoTEdge ShowModule/v2 | 用户通过Console接口查询指定边缘节点上指定边缘模块 | |
| 修改边缘模块 | hcloud IoTEdge UpdateModule/v2 | 用户通过Console接口修改指定边缘节点上指定边缘模块 | |
| 修改边缘模块状态 | hcloud IoTEdge UpdateModuleState/v2 | 用户通过Console接口修改边缘模块状态 | |
| 代理边缘模块消息 | hcloud IoTEdge InvokeModuleMsg/v2 | IoTEdge通过该接口透明代理用户到模块的请求 |
设备管理
外部实体管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 在指定节点上创建外部实体 | hcloud IoTEdge CreateExternalEntity/v2 | 用户通过在指定边缘节点上设置外部实体的接入信息 | |
| 查询指定边缘节点下的外部实体 | hcloud IoTEdge ListExternalEntity/v2 | 用户在指定边缘节点上查询外部实体列表 | |
| 删除指定节点下外部实体 | hcloud IoTEdge DeleteExternalEntity/v2 | 删除节点下外部实体 | |
| 修改节点下指定的外部实体信息 | hcloud IoTEdge UpdateExternalEntity/v2 | 用户通过在指定边缘节点上修改指定外部实体的接入信息 |
数据流转配置管理
北向NA管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询北向NA信息列表 | hcloud IoTEdge ListNas/v2 | 查询北向NA信息列表 | |
| 创建&更新北向NA信息 | hcloud IoTEdge UpdateNa/v2 | 创建&更新北向NA信息 | |
| 查询北向NA信息详情 | hcloud IoTEdge ShowNa/v2 | 查询北向NA信息详情 | |
| 删除北向NA信息 | hcloud IoTEdge DeleteNa/v2 | 删除北向NA信息,如果有边缘节点已分配该NA信息,会通知到边缘节点 | |
| 授权北向NA信息到边缘节点 | hcloud IoTEdge BatchAssociateNaToNodes/v2 | 授权北向NA信息到边缘节点 | |
| 查询该北向NA信息的已分配节点 | hcloud IoTEdge ListNaAuthorizedNodes/v2 | 查询该北向NA信息的已分配节点 |
南向IA配置项管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询南向3rdIA配置项列表 | hcloud IoTEdge ListIaConfigs/v2 | 查询南向3rdIA配置项列表 | |
| 南向3rdIA对配置项下发进行确认 | hcloud IoTEdge BatchConfirmConfigs/v2 | 南向3rdIA对配置项下发进行确认 | |
| 批量确认南向3rdIA配置项 | hcloud IoTEdge BatchConfirmConfigsNew/v2 | 南向3rdIA对下发的配置项进行批量确认 | |
| 批量导入南向3rdIA配置项 | hcloud IoTEdge BatchImportConfigs/v2 | 用户批量上传/导入南向3rdIA配置项 | |
| 创建&更新南向3rdIA配置项信息 | hcloud IoTEdge UpdateIaConfig/v2 | 创建&更新南向3rdIA配置项信息 | |
| 查询南向3rdIA配置项详情 | hcloud IoTEdge ShowIaConfig/v2 | 查询南向3rdIA配置项详情 | |
| 删除南向3rdIA配置项 | hcloud IoTEdge DeleteIaConfig/v2 | 删除南向3rdIA配置项 |
北向HTTP请求代理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| GET方法的代理 | hcloud IoTEdge InvokeGetProxy/v2 | 北向NA调用南向第三方应用的GET方法时使用 | |
| POST方法的代理 | hcloud IoTEdge InvokePostProxy/v2 | 北向NA调用南向第三方应用的POST方法时使用 | |
| DELETE方法的代理 | hcloud IoTEdge InvokeDeleteProxy/v2 | 北向NA调用南向第三方应用的DELETE方法时使用 | |
| PUT方法的代理 | hcloud IoTEdge InvokePutProxy/v2 | 北向NA调用南向第三方应用的PUT方法时使用 | |
| PATCH方法的代理 | hcloud IoTEdge InvokePatchProxy/v2 | 北向NA调用南向第三方应用的PATCH方法时使用 |
边缘数采配置模板
设备控制
调度计划管理
客户端节点管理
控制台节点管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询当前边缘软件版本 | hcloud IoTEdge ShowEdgeNodeSoftwareVersion/v2 | 查询当前边缘软件版本 |
资源管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 绑定节点-专业版 | hcloud IoTEdge BindNode/v2 | 绑定节点-专业版 |