检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 华为HiLens提供了如下接口,基础版控制台接口的说明如表1所示,专业版控制台接口的说明如所示。 表1 基础版控制台接口说明 接口类型 说明 获取设备列表 获取设备列表 获取设备告警列表 获取设备告警列表 表2 专业版控制台接口说明 接口类型 说明 设备管理 管理设备相关操作
API(基础版控制台) 设备管理 技能市场
API(专业版控制台) 设备管理 固件管理 应用部署管理 配置项管理 作业管理 密钥管理 标签管理 工作空间管理 技能市场
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 HIL.0004 Invalid projectId.
如何调用API 构造请求 认证鉴权 返回结果
配置项管理 查询配置项列表 创建配置项 查询配置项详情 更新配置项 删除配置项 父主题: API(专业版控制台)
创建密钥 功能介绍 创建密钥,如果通过在应用部署中配置密钥,容器下发到设备之后,在容器上看到的密钥是解密的 URI POST /v3/{project_id}/ai-mgr/secrets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
设备管理 查询设备列表 注册设备 查询设备详情 更新设备信息 删除设备 启停设备 使用运行服务费激活设备 将激活订单与设备解绑 升级设备固件 获取设备固件升级进度 获取激活记录列表 获取运行服务费订单列表 父主题: API(专业版控制台)
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过视频教程了解如何构造请求调用API 。 请求URI 请求URI由如下部分组成。 {URI-scheme
编辑作业 功能介绍 编辑作业。 URI POST /v3/{project_id}/ai-mgr/deployments/{deployment_id}/task/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署
固件管理 查询固件列表 父主题: API(专业版控制台)
SSH注册HiLens Kit 前提条件 网线连接PC和设备,详细操作请参见连接PC和HiLens Kit。 选择如下方式中的一种组网配置: 无线网络配置(SSH) 有线网络配置(SSH) 不能同时使用无线网络和有线网络连接同一个路由器,无线连接会自动删除默认网关,再次使用有线网络时需要配置默认网关
注册设备 功能介绍 填写设备信息,将设备注册到HiLens专业版控制台上。 URI POST /v3/{project_id}/ai-mgr/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表
启停设备 功能介绍 该API用于启用停用设备。被停用的设备将无法连接到云端服务,重新启用设备恢复连接。 URI POST /v3/{project_id}/ai-mgr/nodes/{node_id}/action/{action} 表1 路径参数 参数 是否必选 参数类型 描述
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个
批量部署 功能介绍 通过指定设备id列表或者设备标签将应用部署下发到多个设备上。 URI PUT /v3/{project_id}/ai-mgr/deployments/{deployment_id}/nodes 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id
删除应用部署 功能介绍 删除指定应用部署。 URI DELETE /v3/{project_id}/ai-mgr/deployments/{deployment_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署ID project_id
技能市场 查询技能列表 获取技能详情 创建免费技能订单 查询订单列表 查询订单详情 父主题: API(专业版控制台)
创建应用部署 功能介绍 创建应用部署。 URI POST /v3/{project_id}/ai-mgr/deployments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参见获取项目ID 表2 Query参数 参数
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头