检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用VR云渲游所提供的接口,您可以完整地使用VR云渲游的所有功能。 VR云渲游终端节点提供的具体API如表1所示。 表1 接口说明 子类型 说明 渲染节点调度 一般由设备调用,用于获取可以连接的GPU云服务器的IP地址等信息。 停止渲染任务 当用户头显处于连接中状
API 渲染任务管理 应用管理 云服务器管理 历史API
历史API 渲染节点调度(区域级) 停止渲染任务(区域级) 父主题: API
如何调用API 构造请求 认证鉴权 返回结果 获取项目ID
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
当指定区域下设备处于连接中状态(运行VR或者3D应用)时,调用此接口,会使当前连接断连,即渲染任务停止。 URI DELETE /v1/{project_id}/cvr/render-task/{task_id} 该接口需要使用区域级终端节点调用,例如需停止华北-北京四区域的渲染任务,请使用华北-北京四的终端节点。
对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头,其中“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
一般由设备调用,用于获取指定区域下,已安装指定应用的GPU云服务器的IP地址、端口等信息。 接口约束 无 URI POST /v1/{project_id}/cvr/node/scheduler 该接口需要使用区域级终端节点调用,例如需进行华北-北京四区域的渲染节点调度,请使用华北-北京四的终端节点。
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:
下的相关云服务器将重新下载安装包进行安装。 已预装的3D应用不支持调用该API修改安装包。 URI PUT /v2/cvr/applications/{application_id}/packages 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选 参数类型
应用管理 获取应用列表 创建应用 修改应用安装包 删除应用 父主题: API
渲染任务管理 渲染节点调度 停止渲染任务 获取渲染任务列表 父主题: API
对于预装的3D应用,不需传此参数。对于VR应用和非预装的3D应用,该参数必选。 对于VR应用和非预装的3D应用,需至少选择一个区域的安装包,请先在OBS桶中上传相关安装包,具体操作请参见VR内容上云。 安装包区域需在当前集群区域范围内,同一区域不能选择多个安装包。 对于VR应用和非预装的3D应用,选择了安装包的区域才能配置该区域的云服务器。
渲染节点调度 功能介绍 一般由设备调用,用于获取已安装指定应用的GPU云服务器的IP地址、端口等信息。 接口约束 无 URI POST /v2/cvr/render-tasks 该接口需要使用global终端节点调用。 请求参数 表1 请求参数 参数 是否必选 参数类型 描述 application_id
云服务器管理 获取指定云服务器上的应用列表 获取云服务器列表 修改云服务器信息 父主题: API
删除应用。执行删除操作后,将从云服务器中卸载该应用。 URI DELETE /v2/cvr/applications/{application_id} 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用ID。
获取指定云服务器上的应用列表 功能介绍 获取指定云服务器上的应用列表,包括需要安装和已经安装的应用。 URI GET /v2/cvr/servers/{server_id}/applications 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选 参数类型 描述
停止渲染任务 功能介绍 当设备处于连接中状态(运行VR或者3D应用)时,调用此接口,会使当前连接断连,即渲染任务停止。 URI POST /v2/cvr/render-tasks/{task_id}/stop 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选 参数类型
安装包信息。 例如,当前集群所在的区域为“北京四”,则根据“获取应用列表”接口查询到的应用安装包信息只显示“北京四”的,不显示“上海一”的。 URI GET /v2/cvr/applications 该接口需要使用global终端节点调用。 请求参数 表1 查询参数 参数 是否必选