检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 华为HiLens提供了如下接口,基础版控制台接口的说明如表1所示,专业版控制台接口的说明如所示。 表1 基础版控制台接口说明 接口类型 说明 获取设备列表 获取设备列表 获取设备告警列表 获取设备告警列表 表2 专业版控制台接口说明 接口类型 说明 设备管理 管理设备
API(基础版控制台) 设备管理 技能市场
如何调用API 构造请求 认证鉴权 返回结果
API(专业版控制台) 设备管理 固件管理 应用部署管理 配置项管理 作业管理 密钥管理 标签管理 工作空间管理 技能市场
文档导读 文档指导您如何安装和配置开发环境、如何通过调用HiLens Framework SDK提供的接口函数进行二次开发。 表1 文档导读 章节 说明 HiLens Framework_C++简介 快速了解HiLens Framework开发工具包。 环境准备 介绍使用HiLens
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过视频教程了解如何构造请求调用API 。 请求URI 请求URI由如下部分组成。 {URI-scheme}
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
编辑作业 功能介绍 编辑作业。 URI POST /v3/{project_id}/ai-mgr/deployments/{deployment_id}/task/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部
技能市场 查询技能列表 获取技能详情 创建免费技能订单 查询订单列表 查询订单详情 父主题: API(专业版控制台)
创建密钥 功能介绍 创建密钥,如果通过在应用部署中配置密钥,容器下发到设备之后,在容器上看到的密钥是解密的 URI POST /v3/{project_id}/ai-mgr/secrets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID
配置项管理 查询配置项列表 创建配置项 查询配置项详情 更新配置项 删除配置项 父主题: API(专业版控制台)
获取设备列表 功能介绍 获取设备列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/device-manager/devices
source String 应用部署来源: HiLens市场(hlm) or aigallery(aig) or 自定义(userdefined) api_version String 应用部署版本 node_ids Array of strings 应用部署的指定节点,与clouster_id二选一
启停设备 使用运行服务费激活设备 将激活订单与设备解绑 升级设备固件 获取设备固件升级进度 获取激活记录列表 获取运行服务费订单列表 父主题: API(专业版控制台)
固件管理 查询固件列表 父主题: API(专业版控制台)
source String 应用部署来源: HiLens市场(hlm) or aigallery(aig) or 自定义(userdefined) api_version String 应用部署版本 node_ids Array of strings 应用部署的指定节点,与clouster_id二选一
删除应用部署 功能介绍 删除指定应用部署。 URI DELETE /v3/{project_id}/ai-mgr/deployments/{deployment_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署ID project_id
注册设备 功能介绍 填写设备信息,将设备注册到HiLens专业版控制台上。 URI POST /v3/{project_id}/ai-mgr/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2
启停设备 功能介绍 该API用于启用停用设备。被停用的设备将无法连接到云端服务,重新启用设备恢复连接。 URI POST /v3/{project_id}/ai-mgr/nodes/{node_id}/action/{action} 表1 路径参数 参数 是否必选 参数类型 描述