华为云用户手册

SDK接口 接口 描述 是否必选 Init.getDevice_id() 【功能说明】 获取设备id，用于作为渲染调度接口的请求参数。 详细使用请参考wwwroot/login.html文件。 是 Init.getDevice_type() 【功能说明】 获取设备类型，用于作为渲染调度接口的请求参数。 详细使用请参考wwwroot/login.html文件。 是 Init.getDevice_brand() 【功能说明】 获取设备品牌，用于作为渲染调度接口的请求参数。 详细使用请参考wwwroot/login.html文件。 是 Init.getProtocol_type() 【功能说明】 获取协议类型，用于作为渲染调度接口的请求参数。 详细使用请参考wwwroot/login.html文件。 是 cloudDesktopApp.loadApp() 【功能说明】 启动并加载云应用。 【请求参数】 详细使用请参考wwwroot/index.html文件。 是 cloudDesktopApp.on() 【功能说明】 回调函数。 ready：连接就绪。 exit：退出回调。 streamPause：串流画面暂停回调。 streamResume：串流画面恢复回调。 appClosed：远程app应用关闭回调。 否 cloudDesktopApp.appEnterFullscreen() 【功能说明】 进入全屏。 否 cloudDesktopApp.appExitFullscreen() 【功能说明】 退出全屏。 否 cloudDesktopApp.restartApp() 【功能说明】 重启远程app。 否 cloudDesktopApp.pauseStream() 【功能说明】 暂停串流画面。 否 cloudDesktopApp.resumeStream() 【功能说明】 恢复串流画面。 否 父主题： 客户端开发

SDK接口参考 接口 描述 是否必选 IntentCVR() 【功能说明】 初始化IntentCVR接口。 是 CVRParameter(std::string userName, std::string userDomain, std::string userPassWord, std::string projectName) 【功能说明】 用户通过该接口配置华为云用户名及密码，客户端根据该信息访问华为云 IAM 获取Token后再连接至VR云渲游平台进行鉴权，以下简称“A类 CVRParameter构造函数”。 【请求参数】 userDomain：华为云租户名 userName：华为云用户名 password：华为云用户密码 projectName：项目名称 说明： 如何获取上述参数对应值，请参考： https://support.huaweicloud.com/sis_faq/sis_04_0032.html 是 CVRParameter构造函数包括A类、B类、C类，请根据需要自选其中一类使用。 三类构造函数的适用场景请参考SDK使用。 CVRParameter(std::string iamToken) 【功能说明】 用户可自行访问IAM 获取Token ，通过该接口注入Token进行CVRParameter初始化，以下简称“B类 CVRParameter构造函数”。 【请求参数】 iamToken：用户Token。 CVRParameter(std::string gpuIp, std::string gpuToken) 【功能说明】 用户自行获取gpuIp与gpuToken，通过该接口配置gpuIp与gpuToken用于设备直连GPU服务器，以下简称“C类 CVRParameter构造函数”。 【请求参数】 gpuIP：GPU服务器公网IP。 gpuIP的获取方式，请参考“渲染节点调度”。 gpuToken：访问GPU服务器所需鉴权Token。 gpuToken的获取方式，请参考“渲染节点调度”。 void setServiceDomain(std::string serviceDomain) 【功能说明】 设置Service 域名 ，用于指定连接的 GPU云服务器 所在区域。 【请求参数】 ServiceDomain：Service域名。 ServiceDomain的取值，请参见“地区和终端节点”中的“终端节点（Endpoint）”。 是 void setAppId(std::string appID) 【功能说明】 设置设备要访问的应用。 【请求参数】 appID：应用对应的应用ID。获取应用ID，请参考APP ID的获取方法。 是 void setPort(int port) 【功能说明】 GPU默认监听端口是10020，如果您更改了GPU监听端口（如使用多路会话模式），则需要使用该接口修改客户端访问端口号 【请求参数】 port：指定设备发送连接请求的目的端口信息。 否 std::string initiateLoad(CVRParameter customParameter) 【功能说明】 加载相关参数，启动云应用流化业务，并对输入参数进行检验。 【请求参数】 customParameter：已经初始化的鉴权参数。 是 void setLocation(std::string location) 【功能说明】 设置客户端连接的目标云服务器所在区域。 【请求参数】 location：用于设置调度接口的策略，可以指定一个或多个区域，CVR服务会从指定区域中分配空闲的服务器。支持配置公有云region_id，如cn-east-3。 如果未设置location，默认为空数组，此时CVR服务会根据设备的调度策略进行GPU服务器的分配。 location的取值，请参见“地区和终端节点”中的“区域”。 否 void setProjectID(std::string projectID) 【功能说明】 设置访问客户端调度接口使用的项目ID。 【请求参数】 projectID：项目ID，用于访问调度接口。获取projectID，请参见“获取项目ID”。 否 仅使用B类的CVRParameter构造函数时需要传入该值。 void setApplicationUserID(std::string userID) 【功能说明】 设置访问客户端调度接口使用的用户标识ID，如不存在用户标识ID，则不需要设置。 【请求参数】 userID：用户标识ID，用于访问调度接口。 否 void setAppLaunchArgs(std::string appLaunchArgs) 【功能说明】 设置应用启动参数，如应用启动无额外参数，则不需要设置。 【请求参数】 appLaunchArgs：应用启动参数。 否 public void setResolution(String resolution) 【功能说明】 设置应用启动的分辨率，默认为1080p。 【请求参数】 resolution：应用启动的分辨率。可以设置的参数为“480p”，“540p”，“720p”，“1080p”，“2k”，“4k” 否 public String getResolution() 【功能说明】 获取设置的应用启动分辨率。 【请求参数】 无 否 public void setGpuIpType(String gpuInfoType) 【功能说明】 设置gpu服务器ip的类型，默认为public。 【请求参数】 gpuInfoType：gpu服务器ip的类型，弹性公有ip填“public”,私有ip填"private"。 否 public String getGpuIpType() 【功能说明】 获取设置的gpu服务器ip类型。 【请求参数】 无 否 std::string getDeviceID() 【功能说明】 获取设备ID。 【请求参数】 无 否 仅使用C类的CVRParameter构造函数时需要获取该值。 std::string getBrand() 【功能说明】 获取设备品牌。 【请求参数】 无 否，仅使用C类的CVRParameter构造函数时需要获取该值。 void setErrCallback(CvrErrCallback errCallback) 【功能说明】 用于获取SDK内部的错误信息并处理。 【请求参数】 errCallback：回调接口，支持用户自定义。相关注意事项请参考错误信息回调。 否 CVRInstance_t* CVRCreateInstance() 【功能说明】 创建一个云应用客户端实例。 【请求参数】 无 是 CVRCode CVRSetConfig(CVRInstance_t* thiz, CVRConfig_t* config) 【功能说明】 对云应用客户端实例设置属性。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 config：CVRConfig_t类型的初始化参数对象。 是 CVRCode CVRStart(CVRInstance_t* thiz) 【功能说明】 开始显示画面。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 是 void CVRSetLogLevel(int level); 【功能说明】 设置日志级别。 【请求参数】 level：范围[0-8]。数值越大，日志越详细。 否 CVRCode CVRSetRenderView(CVRInstance_t* thiz,void* view) 【功能说明】 画面显示在指定窗口句柄。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 view：一个窗口句柄。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRSetControlStateChangedCallback(CVRInstance_t* thiz, CVRControlStateChangedCallback_t callback,void* user_data) 【功能说明】 设置主控模式状态变化的回调通知。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 callback：事件触发时的回调函数。 view：一个窗口句柄。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRSetOnVideoSizeChangedCallback(CVRInstance_t* thiz, CVROnVideoSizeChangedCallback_t callback,void* user_data) 【功能说明】 设置当前视频大小变化的回调通知。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 callback：事件触发时的回调函数。 user_data：设置回调函数中自定义数据。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRSetShowDebug(CVRInstance_t* thiz,int show_debug) 【功能说明】 是否显示调试参数。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRGetStatistics(CVRInstance_t* thiz, CVRStatistics_t* statistics) 【功能说明】 获取当前串流的统计数据。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 statistics：接收相关统计数据的外部变量。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 是 CVRCode CVRGetAuth(CVRInstance_t* thiz, CVRAuth* out_val) 【功能说明】 获取当前是主控客户端还是旁观客户端。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 out_val：接收当前模式的变量。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRSetOnAppClosedCallback(CVRInstance_t* thiz,CVROnAppClosedCallback_t callback,void* user_data) 【功能说明】 设置应用关闭的回调通知。 【请求参数】 thiz：由CVRCreateInstance()创建的云应用客户端实例。 callback：事件触发时的回调函数。 user_data：设置回调函数中自定义数据。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRRestartApp(CVRInstance_t* thiz,bool cancel) 【功能说明】 重新启动应用。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRPause(CVRInstance_t* thiz) 【功能说明】 暂停云应用资源。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 CVRCode CVRResume(CVRInstance_t* thiz) 【功能说明】 恢复云应用资源。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 否 void CVRRelease(CVRInstance_t* thiz) 【功能说明】 获取资源并停止云应用。 【返回值】 返回CVRCode类型的返回码，如果值为CVR_CODE_OK常量，则为成功。 是 父主题： Windows SDK

Visual Studio 2017安装方法 下载Visual Studio 下载地址：https://docs.microsoft.com/en-us/visualstudio/productinfo/vs-roadmap 在归档版本中找到Visual Studio 2017并下载系统匹配的版本。 图1 下载Visual Studio 2017 安装并配置Visual Studio 双击下载的可执行文件进行安装。 图2 双击可执行文件 等待安装完成。 图3 安装Visual Studio 父主题： 附录

Android Studio 3.2.1安装方法 下载Android Studio 下载地址：https://developer.android.google.cn/studio/archive 在归档版本中找到Android Studio3.2.1并下载系统匹配的版本。 图1 下载Android Studio3.2.1 安装并配置Android Studio 在下载文件的“bin”目录下找到并双击“Studio64.exe”执行文件进行安装。 图2 双击“Studio64.exe” 勾选“Android Virtual Devices”选项，然后单击“Next”。 图3 Choose Components 选择Android Studio安装的本地路径，建议不要安装在C盘。 图4 Install Locations 安装设置完成之后，单击“Install”，等待安装完成。 初步设置 安装完成后单击“Finish”，启动Android Studio，此时将会进行首次启动前的初步设置。 如果系统提示您无法访问SDK加载项列表，此时请单击“Cancel”退出，后续会下载SDK。 图5 Android Studio First Run 根据个人喜好选择其他配置，并单击“Next”完成初步设置。 Gradle配置 根据图6所示，完成Gradle配置。 图6 Gradle配置 配置ADB至环境变量 将adb.exe所在路径（Android Studio SDK安装路径“\platform-tools”）添加至Windows系统变量：Path。 图7 adb路径 打开“控制面板”，进入“高级系统设置”。 图8 高级系统设置 单击“环境变量”。 图9 系统属性 在“系统变量”栏，选中“Path”所在行，并单击“编辑”。 图10 环境变量 单击“新建”。 图11 编辑环境变量 添加adb路径，然后单击“确定”。 图12 粘贴adb路径 打开CMD命令提示窗口，输入命令adb，如图13所示，adb环境变量配置成功。 图13 adb命令 至此，Android Studio及adb环境变量配置成功。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65ewtrgaggshhk1223245sghjlse684b", "is_domain": false, "parent_id": "65ewtrgaggshhk1223245sghjlse684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg" }, "id": "a4adasfjljaaaakla12334jklga9sasfg", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

概述 欢迎使用VR云渲游平台（VR Cloud Rendering & Gaming Platform，CVR）。VR云渲游平台基于华为云基础设施多元架构、极致性能、端边云融合等优势，依托华为在处理器、GPU等领域多年技术积累，针对强交互类VR场景，面向教育培训、医疗健康、工业制造、游戏娱乐等行业，使用云渲染流化技术实现VR内容云上实时渲染、编码、推流并提供端侧接入SDK；平台具备对用户渲染集群、连接设备、应用等进行统一管理及细粒度业务监控。具有降低消费成本，提升用户体验，普及商业场景和保护内容版权等显著优势。 本文档提供了VR云渲游平台API的描述、语法、参数说明及示例等内容。 在调用VR云渲游平台API之前，请确保已经充分了解相关概念，详细信息请参见VR云渲游平台的《产品介绍》。 父主题： 使用前必读

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 父主题： 使用前必读

URI DELETE /v1/{project_id}/cvr/render-task/{task_id} 该接口需要使用区域级终端节点调用，例如需停止华北-北京四区域的渲染任务，请使用华北-北京四的终端节点。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户的项目ID。 task_id 是 String 渲染任务的ID，可以在接口渲染节点调度（区域级）的响应信息中获取。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 1234 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint，比如“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 server 否 Object 云服务器信息，详情请参见表3。 表3 server字段数据结构说明 参数 是否必选 参数类型 描述 session_number 否 Integer 需要设置的云服务器会话路数。 取值范围： VR应用云服务器：允许设置为2，4，8。 3D应用云服务器：允许设置为1，2。 约束： 当前会话路数为1路的VR应用云服务器，不允许通过该操作修改会话路数为其它数值。

响应示例 状态码为200时 OK { "server": { "id": "d7acc58a-d83f-44ac-8f57-588832d525aa", "cluster_id": "50adbf76-412a-11eb-821b-fa1640a9b0aa", "publicip": "255.255.255.255", "region_id": "cn-north-4", "volume_size": "98", "total_volume_size": "99", "link_status": "free", "link_device_id": "", "failure_reason": "", "create_time": "2021-02-02T10:20:43Z", "current_application_id": "", "installed_applications": ["4d00636c-6540-11eb-b54a-fa1640a9b0aa"], "name": "ecs-eeee", "status": "ACTIVE", "flavor_display_name": "32vCPUs | 64GB | g5r.8xlarge.2", "availability_zone_id": "cn-north-4a", "image_name": "Windows-Server-2016-64bit", "charging_mode": 0, "privateip": "192.168.0.0", "bandwidth_size": 50, "applications": ["4d00636c-6540-11eb-b54a-fa1640a9b0aa"], "session_number": 2 }} 状态码为400时 { "error_code" : "string", "error_msg" : "string" }

响应参数 状态码为200时 表4 响应Body参数 参数 参数类型 描述 server Object 云服务器信息，详情请参见表5。 表5 server字段数据结构说明 参数 参数类型 描述 availability_zone_id String 云服务器所在可用区。 bandwidth_size Integer 云服务器所绑定带宽的大小。 单位：Mbit/s charging_mode Integer 云服务器的计费模式。 0：表示按需计费。 1：表示包周期计费。 create_time String 云服务器的创建时间。 时间格式例如：2020-05-20T03:30:52Z current_application_id String 云服务器上正在运行应用ID。 failure_reason String 云服务器的故障信息。 privateip String 云服务器所绑定的私有IP。 flavor_display_name String 云服务器的规格显示名称。 格式如下： xvCPUs | yGB | flavor_id x为CPU个数，y为内存大小，flavor_id为规格名。 image_name String 云服务器所安装的镜像名称。 installed_applications Array of strings 已安装的应用ID列表。 link_device_id String 正在连接的设备ID，与云服务器连接设备的唯一标识。 link_status String 设备与云服务器的连接状态。 cluster_id String 集群ID。 name String 云服务器名称。 id String 云服务器ID。 publicip String 云服务器绑定的公网IP。 region_id String 云服务器所在的区域。 status String 云服务器的状态。 total_volume_size Sring 云服务器上安装的云硬盘总量。 单位：GB volume_size String 云服务器上安装的云硬盘剩余量。 单位：GB applications Array of strings 该台云服务器上的所有应用ID列表，包括安装完成的及还未安装完成的应用。 session_number Integer 云服务器的会话路数。 状态码为400时 表6 响应Body参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

响应示例 状态码为200时 OK { "gpu_ip" : "255.255.255.255", "port":"10001", "link_token" : "******", "task_id" : "5afa7bb2-53d7-11eb-a5aa-fa1640a9b003", "application_id": "5afa7bb2-53d7-11eb-a5aa-fa1640a9b002", "application_launch_args": "", "device_id": "477e10fc9938405cb2eceb631a0e6615", "device_brand": "HUAWEI", "device_type": "pc", "application_user": "user1", "protocol_type": "udp", "resolution": "480p", "gpu_ip_type": "private", "location": ["cn-north-1"]} 状态码为400时 { "error_code" : "string", "error_msg" : "string" }

请求示例 请求URL示例 POST https://{endpoint}/v2/cvr/render-tasks 请求示例 { "application_id": "5afa7bb2-53d7-11eb-a5aa-fa1640a9b002", "device_id": "477e10fc9938405cb2eceb631a0e6615", "device_brand": "HUAWEI", "device_type": "pc", "application_user": "user1", "protocol_type": "udp", "location": ["cn-north-1"], "resolution": "480p", "gpu_ip_type": "private"}

响应参数 状态码为200时 表2 响应参数 参数 参数类型 描述 gpu_ip String 分配给设备使用的GPU云服务器的IP地址。 port String 云服务器端口。 link_token String 设备用于连接GPU云服务器的认证凭据。 task_id String 渲染任务的任务ID。 连接任务的唯一标识，格式为UUID。 application_id String 应用ID。 device_id String 设备ID。 device_brand String 设备品牌。 device_type String 设备类型。 application_user String 应用使用用户标识。 application_launch_args String 应用启动参数。 protocol_type String 设备与云服务器进行通信时所使用的协议类型。 location Array of strings 区域列表或边缘小站列表。 resolution String GPU云服务器传给设备的画面分辨率。 gpu_ip_type String 分配给设备使用的GPU云服务器的IP类型。 状态码为400时 表3 响应参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

请求参数 表1 请求参数 参数 是否必选 参数类型 描述 application_id 是 String 设备需要使用的应用ID。 device_id 是 String 设备ID。 长度范围1到40个字符。 只允许输入英文大小写字母、数字及“_”、“-”。 device_brand 否 String 设备品牌。 长度范围1到30个字符。 只允许输入英文大小写字母、数字、空格及“_”、“-”、“.“。 device_type 否 String 设备类型。 device_type的取值范围如下： vr：VR头显 pc：台式机或笔记本电脑 mobile: 手机或平板 ideahub: 智慧屏 VR应用仅支持设备类型为vr，3D应用默认设备类型为pc。 application_launch_args 否 String 应用启动参数。 长度范围1到200个字符。 只允许输入中文字符、英文大小写字母、数字、空格、英文引号及“_”、“-”、“.“、“/”、“:”。 application_user 否 String 应用使用用户标识（该参数仅对3D应用生效）。 长度范围1到40个字符。 只允许输入英文大小写字母、数字及下划线“_”。 protocol_type 否 String 设备与云服务器进行通信时所使用的协议类型。 取值范围如下： udp：集成Android VR SDK的客户端需使用该协议 webrtc: 集成Windows SDK或Android 3D SDK的客户端需使用该协议 websocket:集成Web SDK的客户端需使用该协议 默认值：udp，VR应用仅支持udp协议类型。 location 否 Array of strings 区域列表或边缘小站列表。 分配指定区域中的空闲云服务器。 最多输入10个区域或边缘小站。 每个区域或边缘小站的长度不超过40个字符。 sandbox_enable 否 Boolean 该参数已废弃。 是否支持多路会话的云服务器（该参数仅对VR应用生效）。 true，表示支持多路会话的云服务器。此时，在单路会话和多路会话的云服务器上均可启动渲染任务。 false，表示不支持多路会话的云服务器。此时，只能在单路会话的云服务器上启动渲染任务。 默认值：false。 resolution 否 String GPU云服务器传给设备的画面分辨率（该参数仅对3D应用生效）。 允许输入480p，540p，720p，1080p，2k，4k。 默认值：1080p。 gpu_ip_type 否 String 分配给设备使用的GPU云服务器的IP类型。 public：表示响应的gpu_ip的IP地址为公网，适用于使用公网连接设备与云服务器的场景。 private: 表示响应的gpu_ip的IP地址为私网，适用于使用专线或者内网等连接设备与云服务器的场景。 默认值：public。

请求参数 表1 查询参数 参数 是否必选 参数类型 描述 name 否 String 根据应用名称进行模糊搜索。 id 否 String 根据应用ID进行精确搜索。 limit 否 Integer 每页显示的条目数量。 默认为1000，最大值为1000。 offset 否 Integer 偏移量，表示从此偏移量开始查询。 默认为0，最大值为1000。 status 否 String 应用的状态。 status的取值范围如下： active：正常 creating：创建中 create_failed：创建失败 updating：修改中 update_failed：修改失败 deleting：删除中 delete_failed：删除失败 adding：添加中（添加云服务器） add_failed：添加失败 repairing：修复中 repair_failed：修复失败 说明： 使用取值范围以外的status字段进行查询，将返回错误码。

响应参数 状态码为200时 表2 响应参数 参数 参数类型 描述 count Integer 应用数量。 applications Array of objects 应用列表信息，详情请参见表3。 表3 application字段数据结构说明 参数 参数类型 描述 id String 应用ID。 应用的唯一标识，格式为UUID。 name String 应用名称。 session_hold_time Integer 会话保持时间，单位分钟（min）。 若该值为-1，表示会话一直保持。 type String 应用类型。 应用类型枚举值： vr：表示VR应用。 3d：表示3D应用。 launch_path String 应用启动路径。 create_time String 应用创建时间。 时间格式例如：2020-05-20T03:30:52Z status String 应用状态。 应用状态枚举值： active：正常 creating：创建中 create_failed：创建失败 updating：修改中 update_failed：修改失败 deleting：删除中 delete_failed：删除失败 adding：添加中（添加云服务器） add_failed：添加失败 repairing：修复中 repair_failed：修复失败 description String 应用描述。 icon_name String 应用的图标名称。 cluster_id String 集群ID 。 应用所属集群的唯一标识，格式为UUID。 policy_type String 设备连接策略规则（黑、白名单）。 black_list：表示黑名单。 white_list：表示白名单。 package_list Array of objects 应用的安装包信息列表，详情请参见表4。 表4 package字段数据结构说明 参数 参数类型 描述 bucket_name String 安装包所在OBS桶名称。 示例：cloudvr package_name String 安装包名称。 示例：cvrapp.zip package_size String 安装包大小。 示例：100MB bucket_region String OBS桶所在区域。 示例：cn-north-4 状态码为400时 表5 响应参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

响应示例 状态码为200时 { "count": 1, "applications": [ { "id": "fe8e97a0-4350-11eb-8bb9-fa1640a9b002", "name": "appname", "type": "vr", "session_hold_time": 3, "launch_path": "", "create_time": "2020-12-21T05:54:31Z", "status": "active", "description": "1234", "icon_name": "image_default.png", "policy_type": "black_list", "cluster_id": "50adbf76-412a-11eb-821b-fa1640a9b002", "package_list": [ { "bucket_name": "cvr1", "package_name": "1.zip", "package_size": "324.83MB", "bucket_region": "cn-north-4" }, { "bucket_name": "cvr2", "package_name": "2.zip", "package_size": "324.83MB", "bucket_region": "cn-east-3" } ] } ] 状态码为400时 { "error_code" : "string", "error_msg" : "string" }

请求示例 请求URL示例 POST https://{endpoint}/v1/{project_id}/cvr/node/scheduler 请求示例 { "app_id": "5afa7bb2-53d7-11eb-a5aa-fa1640a9b002", "device_id": "477e10fc9938405cb2eceb631a0e6615", "device_brand": "HUAWEI", "device_type": "pc", "application_user": "user1", "protocol_type": "udp", "location": ["cn-north-1"], "resolution": "480p", "gpu_ip_type": "private"}

响应示例 状态码为200时 OK { "gpu_ip" : "255.255.255.255", "link_token" : "******", "task_id" : "5afa7bb2-53d7-11eb-a5aa-fa1640a9b003", "port":"10001"} 状态码为400时 { "error_code" : "string", "error_msg" : "string" }

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": $ADMIN_PASS, //IAM用户密码，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } }} 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 123 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

响应参数 状态码为200时 表3 响应参数 参数 参数类型 描述 gpu_ip String 分配给设备使用的GPU云服务器的IP地址。 link_token String 设备用于连接GPU云服务器的认证凭据。 task_id String 渲染任务的任务ID。 port String 云服务器端口。 状态码为400时 表4 响应参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 app_id 是 String 设备需要使用的应用ID。 device_id 是 String 设备ID。 长度范围1到40个字符。 只允许输入英文大小写字母、数字及“_”、“-”。 device_brand 否 String 设备品牌。 长度范围1到30个字符。 只允许输入英文大小写字母、数字、空格及“_”、“-”、“.“。 device_type 否 String 设备类型。 device_type的取值范围如下： vr：VR头显 pc：台式机或笔记本电脑 mobile: 手机或平板 ideahub: 智慧屏 VR应用仅支持设备类型为vr，3D应用默认设备类型为pc。 application_launch_args 否 String 应用启动参数。 长度范围1到200个字符。 只允许输入中文字符、英文大小写字母、数字、空格、英文引号及“_”、“-”、“.“、“/”、“:”。 application_user 否 String 应用使用用户标识（该参数仅对3D应用生效）。 长度范围1到40个字符。 只允许输入英文大小写字母、数字及下划线“_”。 protocol_type 否 String 设备与云服务器进行通信时所使用的协议类型。 取值范围如下： udp：集成Android VR SDK的客户端需使用该协议 webrtc: 集成Windows SDK或Android 3D SDK的客户端需使用该协议 websocket:集成Web SDK的客户端需使用该协议 默认值：udp，VR应用仅支持udp协议类型。 location 否 Array of strings 区域列表或边缘小站列表。 分配指定区域中的空闲云服务器。 最多输入10个区域或边缘小站。 每个区域或边缘小站的长度不超过40个字符。 sandbox_enable 否 Boolean 该参数已废弃。 是否支持多路会话的云服务器（该参数仅对VR应用生效）。 true，表示支持多路会话的云服务器。此时，在单路会话和多路会话的云服务器上均可启动渲染任务。 false，表示不支持多路会话的云服务器。此时，只能在单路会话的云服务器上启动渲染任务。 默认值：false。 resolution 否 String GPU云服务器传给设备的画面分辨率（该参数仅对3D应用生效）。 允许输入480p，540p，720p，1080p，2k，4k。 默认值：1080p。 gpu_ip_type 否 String 分配给设备使用的GPU云服务器的IP类型。 public：表示响应的gpu_ip的IP地址为公网，适用于使用公网连接设备与云服务器的场景。 private: 表示响应的gpu_ip的IP地址为私网，适用于使用专线或者内网等连接设备与云服务器的场景。 默认值：public。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求示例 请求URL示例 POST https://{endpoint}/v2/cvr/applications 请求示例 创建应用，选择上海一和北京四的安装包，使用北京四区域的已有云服务器。 { "application": { "name": "test", "description": "1234", "type": "vr", "session_hold_time": 3, "policy": { "type": "black_list", "devices": [ "111111111" ] }, "package_list": [ { "bucket_name": "cvr1", "package_name": "1.zip", "bucket_region": "cn-north-4" }, { "bucket_name": "cvr2", "package_name": "2.zip", "bucket_region": "cn-east-3" } ], "existed_servers": [ { "server_id": "a4a4ae15-c7eb-40b5-9d0e-7f611404e112" }, { "server_id": "efd3ae15-c7eb-40b5-9d0e-7f611404e111" }, ] }}

响应参数 状态码为200时 表6 响应Body参数 参数 参数类型 描述 application Object 应用信息，详情请参见表7。 表7 application字段数据结构说明 参数 参数类型 描述 id String 应用ID。 应用的唯一标识，格式为UUID。 name String 应用名称。 session_hold_time Integer 会话保持时间，单位分钟（min）。 若该值为-1，表示会话一直保持。 type String 应用类型。 应用类型枚举值： vr：表示VR应用。 3d：表示3D应用。 launch_path String 应用启动路径。 create_time String 应用创建时间。 时间格式例如：2020-05-20T03:30:52Z status String 应用状态。 应用状态枚举值： active：正常 creating：创建中 create_failed：创建失败 updating：修改中 update_failed：修改失败 deleting：删除中 delete_failed：删除失败 adding：添加中（添加云服务器） add_failed：添加失败 repairing：修复中 repair_failed：修复失败 description String 应用描述。 icon_name String 应用的图标名称。 cluster_id String 集群ID 。 应用所属集群的唯一标识，格式为UUID。 policy_type String 设备连接策略规则（黑、白名单）。 black_list：表示黑名单。 white_list：表示白名单。 package_list Array of objects 应用的安装包信息列表，详情请参见表8。 表8 package字段数据结构说明 参数 参数类型 描述 bucket_name String 安装包所在OBS桶名称。 示例：cloudvr package_name String 安装包名称。 示例：cvrapp.zip package_size String 安装包大小。 示例：100MB bucket_region String OBS桶所在区域。 示例：cn-north-4 状态码为400时 表9 响应Body参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。