检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过视频教程了解如何构造请求调用API 。 请求URI 请求URI由如下部分组成。 {URI-scheme
基本概念 帐号 用户注册华为云时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员
初始化HiLens Framework 该接口用于初始化HiLens Framework。在调用HiLens Framework的其他接口之前,需要先做全局初始化。 接口调用 hilens.init(verify) 参数说明 表1 参数说明 参数名 是否必选 参数类型 描述 verify
如何调用API 构造请求 认证鉴权 返回结果
获取项目ID 从控制台获取项目ID 登录管理控制台。 在页面右上角单击用户名,在下拉列表中单击“我的凭证”,进入“我的凭证”页面。 在项目列表中查看“项目ID”和“项目”(“项目”即项目名称)。 图1 查看项目ID 多项目时,展开“所属区域”,从“项目ID”列获取子项目ID。项目编码需与华为
将激活订单与设备解绑 功能介绍 将激活订单与设备解绑。 URI POST /v3/{project_id}/ai-mgr/nodes/{node_id}/deactivate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目
删除设备 功能介绍 删除专业版HiLens控制台上的设备,并与端侧的设备进行解绑。 URI DELETE /v3/{project_id}/ai-mgr/nodes/{node_id} 表1 路径参数 参数 是否必选 参数类型 描述 node_id 是 String 设备ID,从专业版
删除密钥 功能介绍 删除密钥 URI DELETE /v3/{project_id}/ai-mgr/secrets/{secret_id} 表1 路径参数 参数 是否必选 参数类型 描述 secret_id 是 String 密钥ID,从专业版HiLens控制台密钥管理获密钥列表获取
删除作业 功能介绍 删除作业。 URI DELETE /v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String
修改工作空间 功能介绍 更改工作空间信息,暂时只能更改描述 URI PUT /v3/{project_id}/ai-mgr/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id
删除工作空间 功能介绍 删除指定ID的工作空间,如果该工作空间下仍有资源,则删除会失败 URI DELETE /v3/{project_id}/ai-mgr/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
删除配置项 功能介绍 根据配置项id删除某个配置项 URI DELETE /v3/{project_id}/ai-mgr/configmaps/{config_map_id} 表1 路径参数 参数 是否必选 参数类型 描述 config_map_id 是 String 配置项ID,
启停设备 功能介绍 该API用于启用停用设备。被停用的设备将无法连接到云端服务,重新启用设备恢复连接。 URI POST /v3/{project_id}/ai-mgr/nodes/{node_id}/action/{action} 表1 路径参数 参数 是否必选 参数类型 描述
创建工作空间 功能介绍 创建一个工作空间,其中工作空间名不能与已有的重复 URI POST /v3/{project_id}/ai-mgr/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目
删除资源标签 功能介绍 专业版HiLens控制台标签管理,删除对应资源的标签 URI DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
升级设备固件 功能介绍 升级设备固件。 URI PUT /v3/{project_id}/node-manager/node/{node_id}/firmware/{firmware_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
使用运行服务费激活设备 功能介绍 使用运行服务费激活设备。 URI POST /v3/{project_id}/ai-mgr/nodes/{node_id}/activate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
错误码 HiLens Framework以枚举类型返回错误码,当调用接口发生错误并返回错误码时,可以查看以下枚举类来获取错误信息: 表1 错误码 错误码 说明 UNKNOWN_ERROR 未知错误。 INIT_CURL_ERROR 初始化CURL错误。 CREATE_DIR_FAILED
获取设备固件升级进度 功能介绍 获取设备固件升级进度。 URI GET /v3/{project_id}/node-manager/node/{node_id}/firmware/upgrade-progress 表1 路径参数 参数 是否必选 参数类型 描述 project_id