CLI命令参考
边缘节点管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 注册边缘节点 | hcloud IEF CreateEdgeNode | 该API用于注册一个边缘节点。接口调用成功后,您可以将响应消息体中node.package字段使用base64解码成tar.gz文件,并在控制台下载边缘核心软件,然后纳管边缘节点。 | |
| 查询边缘节点列表 | hcloud IEF ListEdgeNodes | 该API用于查询边缘节点列表。 | |
| 更新边缘节点 | hcloud IEF UpdateEdgeNode | 该API用于更新边缘节点。 | |
| 查询边缘节点详情 | hcloud IEF ShowEdgeNodeDetail | 查询边缘节点详情。 | |
| 删除边缘节点 | hcloud IEF DeleteEdgeNode | 删除边缘节点 | |
| 启用停用边缘节点 | hcloud IEF EnableDisableEdgeNodes | 启用停用边缘节点。被停用的边缘节点将无法连接到云端服务,可用该URI启用边缘节点恢复连接。 | |
| 更新边缘节点的终端设备 | hcloud IEF UpdateEdgeNodeDevice | 添加或删除边缘节点的终端设备 | |
| 查询节点证书 | hcloud IEF ListEdgeNodeCerts | 查询边缘节点上的应用证书和设备证书。 | |
| 创建节点证书 | hcloud IEF CreateEdgeNodeCerts | 创建边缘节点上的应用证书和设备证书。 | |
| 删除节点证书 | hcloud IEF DeleteEdgeNodeCerts | 删除边缘节点上的证书(目前只支持删除应用证书和设备证书) | |
| 升级边缘节点 | hcloud IEF UpgradeEdgeNode | 该API用于升级边缘节点。边缘节点将自动升级到最新的可用版本 |
边缘节点组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询边缘节点组列表 | hcloud IEF ListEdgeGroups | 查询边缘节点组列表。该API只能在铂金版实例中使用 | |
| 创建边缘节点组 | hcloud IEF CreateEdgeGroup | 创建边缘节点组。该API只能在铂金版实例中使用 | |
| 查询边缘节点组详情 | hcloud IEF ShowEdgeGroupDetail | 查询边缘节点组详情。该API只能在铂金版实例中使用 | |
| 更新边缘节点组 | hcloud IEF UpdateEdgeGroup | 更新边缘节点组描述。该API只能在铂金版实例中使用 | |
| 删除边缘节点组 | hcloud IEF DeleteEdgeGroup | 删除边缘节点组。该API只能在铂金版实例中使用 | |
| 绑定或解绑边缘节点 | hcloud IEF UpdateEdgeGroupNodeBinding | 边缘节点组绑定或解绑边缘节点。该API只能在铂金版实例中使用 | |
| 查询边缘节点组证书列表 | hcloud IEF ListEdgeGroupCerts | 查询边缘节点组证书列表 | |
| 创建边缘节点组证书 | hcloud IEF CreateEdgeGroupCert | 创建边缘节点组证书。边缘节点组证书.tar.gz文件仅在调用该API时提供压缩包下载,请及时下载证书文件 | |
| 查询边缘节点组证书详情 | hcloud IEF ShowEdgeGroupCertDetail | 查询边缘节点组证书详情 | |
| 删除边缘节点组证书 | hcloud IEF DeleteEdgeGroupCert | 删除边缘节点组证书 |
终端设备管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 注册终端设备 | hcloud IEF CreateDevice | 注册终端设备。 | |
| 查询终端设备列表 | hcloud IEF ListDevices | 该API用于查询终端设备列表。 | |
| 更新终端设备 | hcloud IEF UpdateDevice | 更新一个终端设备。 | |
| 查询终端设备详情 | hcloud IEF ShowDevice | 该API用于查询终端设备详情。 | |
| 删除终端设备 | hcloud IEF DeleteDevice | 该API用于删除终端设备。 | |
| 更新终端设备的边缘节点 | hcloud IEF UpdateNodeByDeviceId | 该API用于更新终端设备的边缘节点。功能与更新边缘节点的终端设备相同,推荐使用更新边缘节点的终端设备。 | |
| 查询终端设备孪生 | hcloud IEF ShowDeviceTwin | 该API用于查询终端设备孪生。 | |
| 更新终端设备孪生 | hcloud IEF UpdateDeviceTwin | 该API用于更新终端设备孪生。 |
终端设备模板管理
应用模板管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建应用模板 | hcloud IEF CreateApp | 该API用于创建一个应用模板。 | |
| 查询应用模板列表 | hcloud IEF ListApps | 查询应用模板列表 | |
| 更新应用模板 | hcloud IEF UpdateApp | 更新一个应用模板。 | |
| 查询应用模板详情 | hcloud IEF ShowAppDetail | 查询应用模板详情。 | |
| 删除应用模板 | hcloud IEF DeleteApp | 删除应用模板 | |
| 创建应用模板版本 | hcloud IEF CreateAppVersions | 创建一个应用模板版本 | |
| 查询应用模板版本列表 | hcloud IEF ListAppVersions | 查询应用模板版本列表 | |
| 更新应用模板版本 | hcloud IEF UpdateAppVersion | 更新一个应用模板版本 | |
| 查询应用模板版本详情 | hcloud IEF ShowAppVersionDetail | 查询应用模板版本详情 | |
| 删除应用版本 | hcloud IEF DeleteAppVersion | 删除应用版本 |
部署管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建部署 | hcloud IEF CreateDeployments | 创建部署 | |
| 查询部署列表 | hcloud IEF ListDeployments | 查询部署列表 | |
| 更新应用部署 | hcloud IEF UpdateDeployment | 修改应用部署 | |
| 删除部署 | hcloud IEF DeleteDeployment | 删除应用部署 | |
| 查询应用部署 | hcloud IEF ShowDeployment | 查询应用部署 | |
| 查询应用实例列表 | hcloud IEF ListPods | 查询应用实例列表 | |
| 容器应用实例重启 | hcloud IEF RestartDeploymentsPod | 重启部署下的应用实例 | |
| 删除容器应用实例 | hcloud IEF DeletePod | 删除部署下的应用实例。应用实例在删除后会自动重新拉起。 |
标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 添加资源标签 | hcloud IEF CreateTag | 为资源添加标签。 | |
| 查询资源标签 | hcloud IEF ListTags | 查询指定实例的标签信息 | |
| 查询资源实例 | hcloud IEF ListResourceByTags | 使用标签过滤实例 | |
| 批量添加删除资源标签 | hcloud IEF BatchAddDeleteTags | 为指定实例批量添加或删除标签。 | |
| 删除资源标签 | hcloud IEF DeleteResourceTag | 删除资源标签。删除时不对标签字符集做校验,调用前必须要做encodeURI,服务端需要对接口uri做decodeURI。删除的key不存在报404,Key不能为空或者空字符串。 | |
| 查询项目标签 | hcloud IEF ListTagsByResourceType | 查询指定项目中实例类型的所有资源标签集合 |
配置项管理
密钥管理
端点管理
规则管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询规则列表 | hcloud IEF ListRules | 查询到所有的规则 | |
| 创建规则 | hcloud IEF CreateRule | 创建一条规则 | |
| 查询规则详情 | hcloud IEF ShowRuleDetail | 获取一条规则的详情 | |
| 删除规则 | hcloud IEF DeleteRule | 删除一条规则 | |
| 查询规则错误列表 | hcloud IEF ListRuleErrors | 查询特定规则下的所有错误列表 | |
| 启用规则 | hcloud IEF StartRule | 启用一条规则 | |
| 停用规则 | hcloud IEF StopRule | 停用一条规则 |
服务管理
系统订阅管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询系统订阅列表 | hcloud IEF ListSystemEvents | 查询系统订阅列表 | |
| 创建系统订阅 | hcloud IEF CreateSystemEvent | 创建系统订阅 | |
| 查询系统订阅详情 | hcloud IEF ShowSystemEventDetail | 查询系统订阅详情 | |
| 删除系统订阅 | hcloud IEF DeleteSystemEvent | 删除系统订阅 | |
| 启用系统订阅 | hcloud IEF StartSystemEvent | 启用系统订阅 | |
| 停用系统订阅 | hcloud IEF StopSystemEvent | 停用系统订阅 |
加密数据管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取加密数据列表 | hcloud IEF ListEncryptdatas | 获取加密数据列表 | |
| 新增加密数据 | hcloud IEF CreateEncryptdatas | 新增加密数据 | |
| 更新加密数据 | hcloud IEF UpdateEncryptdatas | 更新加密数据 | |
| 删除加密数据 | hcloud IEF DeleteEncryptdatas | 删除加密数据 | |
| 查询加密数据详情 | hcloud IEF ShowEncryptdatas | 查询加密数据详情 | |
| 加密数据绑定边缘节点 | hcloud IEF CreateNodeEncryptdatas | 加密数据绑定边缘节点 | |
| 获取边缘节点绑定的加密数据 | hcloud IEF ListNodeEncryptdatas | 获取边缘节点绑定的加密数据 | |
| 解绑边缘节点的加密数据 | hcloud IEF DeleteNodeEncryptdatas | 解绑边缘节点的加密数据 | |
| 获取加密数据绑定的边缘节点 | hcloud IEF ListEncryptdataNodes | 获取加密数据绑定的边缘节点 |
批量节点管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建批量节点注册作业 | hcloud IEF CreateProduct | 创建批量节点注册作业。接口调用成功后,您可以将响应消息体中product.package字段使用base64解码成tar.gz产品证书文件,并在控制台下载边缘注册软件edge-register和edge-installer,使用该产品证书批量纳管边缘节点。 | |
| 查询批量节点注册作业列表 | hcloud IEF ListProducts | 查询批量节点注册作业列表 | |
| 删除批量节点注册作业 | hcloud IEF DeleteProduct | 删除批量节点注册作业。接口调用成功后,与该批量注册任务关联的批量注册凭证将会失效 | |
| 查询批量节点注册作业详情 | hcloud IEF ShowProductDetail | 查询批量节点注册作业详情。该接口无法查询产品证书文件 |
批量作业管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询批量处理作业列表 | hcloud IEF ListBatchJob | 查询批量处理作业列表 | |
| 创建批量处理任务 | hcloud IEF CreateBatchJob | 创建批量处理作业。该API用于创建批量处理作业,当前支持:批量节点升级、批量应用部署、批量应用升级 | |
| 查询批量处理作业详情 | hcloud IEF ShowBatchJob | 查询批量处理作业详情 | |
| 删除批量处理作业 | hcloud IEF DeleteBatchJob | 删除批量处理作业 | |
| 停止批量处理作业 | hcloud IEF StopBatchJob | 停止批量处理作业。该API仅对运行中的批量处理作业生效 | |
| 继续批量处理作业 | hcloud IEF RestoreBatchJob | 继续执行批量处理作业。该API只对停止的批量处理作业生效 | |
| 重试批量处理作业 | hcloud IEF RetryBatchJob | 重试批量处理作业。该API仅对执行状态失败的批量处理作业生效 |
配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询IEF服务下的资源配额 | hcloud IEF ShowQuota | 查询IEF服务下的资源配额 |