检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
状态码 正常 返回值 类型 说明 200 OK GET、PUT、POST操作正常返回 204 No Content DELETE操作正常返回 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。
修改云服务器信息 功能介绍 修改云服务器信息,包括云服务器会话路数。调用该接口进行云服务器会话路数更新时,会自动重启云服务器后生效。 URI PUT /v2/cvr/servers/{server_id} 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选 参数类型
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
Example示例 本章节为测试示例,方便您快速调通整个流程并体验。 具体操作如下: 解压Sdk后的目录。 图1 Sdk目录 确保环境已经安装dotnet 5.0(若没有安装,运行CloudVR-Web-SDK.exe会出现闪退)。 配置config.yml信息。 表1 参数说明
错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 CVR.0001 Format of the request body is error. 消息体格式错误 请确认消息体格式是否为json格式 400 CVR.0002 The page
获取云服务器列表 功能介绍 获取云服务器列表。 URI GET /v2/cvr/servers 该接口需要使用global终端节点调用。 请求参数 表1 查询参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的条目数量。 默认为1000,最大值为1000
获取应用列表 功能介绍 获取应用列表,可查看应用基本信息,如应用安装包。 其中,应用的安装包信息受限于集群所选择的区域,因此不会返回当前集群所在区域以外其他区域的安装包信息。 例如,当前集群所在的区域为“北京四”,则根据“获取应用列表”接口查询到的应用安装包信息只显示“北京四”的,
获取指定云服务器上的应用列表 功能介绍 获取指定云服务器上的应用列表,包括需要安装和已经安装的应用。 URI GET /v2/cvr/servers/{server_id}/applications 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选 参数类型
SDK接口参考 接口 描述 是否必选 IntentCVR() 【功能说明】 初始化IntentCVR接口。 是 CVRParameter(std::string userName, std::string userDomain, std::string userPassWord,
停止渲染任务 功能介绍 当设备处于连接中状态(运行VR或者3D应用)时,调用此接口,会使当前连接断连,即渲染任务停止。 URI POST /v2/cvr/render-tasks/{task_id}/stop 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选
删除应用 功能介绍 删除应用。执行删除操作后,将从云服务器中卸载该应用。 URI DELETE /v2/cvr/applications/{application_id} 该接口需要使用global终端节点调用。 表1 路径参数 参数 是否必选 参数类型 描述 application_id
获取渲染任务列表 功能介绍 获取渲染任务列表。 仅支持查询90天内的渲染任务信息。 URI GET /v2/cvr/render-tasks 该接口需要使用global终端节点调用。 请求参数 表1 查询参数 参数 是否必选 参数类型 描述 status 否 String 任务状态
创建应用 功能介绍 创建一个应用,应用会自动安装到选择的云服务器上。 创建应用时,应用安装包区域需在当前集群区域范围内,若为VR应用或非预装的3D应用,需至少选择一个区域的安装包,选择了安装包的区域才能配置该区域的云服务器。预装的3D应用配置云服务器时无安装包区域限制。 一个用户最多创建
附录 状态码 错误码
停止渲染任务(区域级) 功能介绍 当指定区域下设备处于连接中状态(运行VR或者3D应用)时,调用此接口,会使当前连接断连,即渲染任务停止。 URI DELETE /v1/{project_id}/cvr/render-task/{task_id} 该接口需要使用区域级终端节点调用,
修改应用安装包 功能介绍 修改指定应用的安装包。修改完成后,该应用安装包区域下的相关云服务器将重新下载安装包进行安装。 已预装的3D应用不支持调用该API修改安装包。 URI PUT /v2/cvr/applications/{application_id}/packages 该接口需要使用
渲染节点调度 功能介绍 一般由设备调用,用于获取已安装指定应用的GPU云服务器的IP地址、端口等信息。 接口约束 无 URI POST /v2/cvr/render-tasks 该接口需要使用global终端节点调用。 请求参数 表1 请求参数 参数 是否必选 参数类型 描述 application_id
渲染节点调度(区域级) 功能介绍 一般由设备调用,用于获取指定区域下,已安装指定应用的GPU云服务器的IP地址、端口等信息。 接口约束 无 URI POST /v1/{project_id}/cvr/node/scheduler 该接口需要使用区域级终端节点调用,例如需进行华北-北京四区域的渲染节点调度