检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过视频教程了解如何构造请求调用API 。 请求URI 请求URI由如下部分组成。 {URI-scheme}
公共响应参数 表1 公共响应消息头 参数名 说明 Content-Length 响应消息体的字节长度,单位为Byte。 Date 系统响应的时间。 Content-type 发送的实体的MIME类型。 父主题: 数据结构
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
请确保已经充分了解华为HiLens服务相关概念,详细信息请参见产品介绍。 华为HiLens服务以开放API的方式提供给用户,您可以根据本文档提供的API使用服务,支持的全部API请参见API概览。 父主题: 使用前必读
调用说明 华为HiLens服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
创建密钥 功能介绍 创建密钥,如果通过在应用部署中配置密钥,容器下发到设备之后,在容器上看到的密钥是解密的 URI POST /v3/{project_id}/ai-mgr/secrets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID
101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 200 OK 接口调用成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 HIL.0004 Invalid projectId. 非法的项目ID 检查是否输入错误的项目ID 400 HIL.0055
source String 应用部署来源: HiLens市场(hlm) or aigallery(aig) or 自定义(userdefined) api_version String 应用部署版本 node_ids Array of strings 应用部署的指定节点,与clouster_id二选一
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
更新密钥 功能介绍 更新密钥 URI PUT /v3/{project_id}/ai-mgr/secrets/{secret_id} 表1 路径参数 参数 是否必选 参数类型 描述 secret_id 是 String 密钥ID,从专业版HiLens控制台密钥管理获取密钥列表获取
删除资源标签 功能介绍 专业版HiLens控制台标签管理,删除对应资源的标签 URI DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询密钥详情 功能介绍 查询密钥详情 URI GET /v3/{project_id}/ai-mgr/secrets/{secret_id} 表1 路径参数 参数 是否必选 参数类型 描述 secret_id 是 String 密钥ID,从专业版HiLens控制台密钥管理获取密钥列表获取
注册设备 功能介绍 填写设备信息,将设备注册到HiLens专业版控制台上。 URI POST /v3/{project_id}/ai-mgr/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2
编辑作业 功能介绍 编辑作业。 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/nodes/{node_id}/action/{action} 表1 路径参数 参数 是否必选 参数类型 描述
项目编码需与华为HiLens服务终端节点保持一致,当访问华北-北京四的终端节点(即hilens.cn-north-4.myhuaweicloud.com时),项目对应需为cn-north-4。 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET
source String 应用部署来源: HiLens市场(hlm) or aigallery(aig) or 自定义(userdefined) api_version String 应用部署版本 node_ids Array of strings 应用部署的指定节点,与clouster_id二选一
获取设备列表 功能介绍 获取设备列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/device-manager/devices
创建免费技能订单 功能介绍 创建免费技能订单 URI POST /v1/{project_id}/skill-market/skill-order 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参见获取项目ID 请求参数