华为云用户手册

请求参数 表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。

响应参数 状态码为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 查询参数 参数 是否必选 参数类型 描述 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" }

响应参数 状态码为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 错误的英文描述。

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。

请求参数 表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时 { "application": { "id": "fe8e97a0-4350-11eb-8bb9-fa1640a9b002", "name": "test", "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" }

响应参数 状态码为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 错误的英文描述。

响应参数 状态码为200时 表4 响应Body参数 参数 参数类型 描述 application Object 应用信息，详情请参见表5。 表5 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 应用的安装包信息列表，详情请参见表6。 表6 package字段数据结构说明 参数 参数类型 描述 bucket_name String 安装包所在OBS桶名称。 示例：cloudvr package_name String 安装包名称。 示例：cvrapp.zip package_size String 安装包大小。 示例：100MB bucket_region String OBS桶所在区域。 示例：cn-north-4 状态码为400时 表7 响应Body参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 package_list 是 Array of objects 应用安装包，详情请参见表3。 约束： 需至少选择一个区域的安装包，请先在OBS桶中上传相关安装包，具体操作请参见VR内容上云。 安装包区域需在当前集群区域范围内，同一区域不能选择多个安装包。 launch_path 否 String 应用启动路径（相对路径）。 修改3D应用的应用安装包时，若应用启动路径发生变化，可同时修改应用启动路径。 取值范围： 长度范围1到200个字符。 只允许输入中文字符、英文大小写字母、数字、空格及“_”、“-”、“.“、“/”。 archive_data 否 Boolean 是否保留相关云服务器上该应用旧数据。 true，表示保留相关云服务器上该应用旧数据。 false，表示不保留相关云服务器上该应用旧数据。 默认值：false。 表3 package字段数据结构说明 参数 是否必选 参数类型 描述 bucket_name 是 String 安装包所在OBS桶名称。 示例：cloudvr package_name 是 String 安装包名称。 示例：cvrapp.zip bucket_region 是 String OBS桶所在区域。 示例：cn-north-4

响应示例 状态码为200时 { "application": { "id": "fe8e97a0-4350-11eb-8bb9-fa1640a9b002", "name": "test", "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" }

响应示例 状态码为200时 OK { "count":1, "servers": [ { "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" }

请求参数 表1 查询参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的条目数量。 默认为1000，最大值为1000。 offset 否 Integer 偏移量，表示从此偏移量开始查询。 默认为0，最大值为1000。 link_status 否 String 当前设备与云服务器的连接状态。 连接状态枚举值： free： 闲置 lost：失联 error：异常 use： 正常 init：初始化 publicip 否 String 云服务器绑定的公网IP地址，只支持精确匹配。 用于设备与云服务器进行网络数据传输。 name 否 String 根据云服务器名称进行模糊搜索。 privateip 否 String 云服务器绑定的私有IP地址，只支持精确搜索。 application_id 否 String 根据应用ID进行精确搜索。 可查看该应用下的云服务器列表（包括已安装该应用及安装未完成的）。 status 否 String 云服务器的当前状态。 状态枚举值： ACTIVE： 实例正常运行状态。 SHUTOFF：实例被正常停止。 BUILD：创建实例后，在实例状态进入运行中之前的状态。 ERROR： 实例处于异常状态。 region_id 否 String 云服务器所在的区域。 区域枚举值（当前仅支持以下三个区域）： cn-north-4：华北-北京四 cn-east-3：华东-上海一 cn-south-1：华南-广州

响应参数 状态码为200时 表2 响应Body参数 参数 参数类型 描述 count Integer 云服务器数量。 servers Array of objects 云服务器信息列表，详情请参见表3。 表3 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时 表4 响应Body参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

响应示例 状态码为200时 { "count": 1, "render_tasks": [ { "task_id": "5a229588-7bea-11eb-bb6d-84a93e805fe6", "application_id": "63b79e6e-7be9-11eb-8817-84a93e805fe6", "server_id": "63231434-7bea-11eb-9409-84a93e805fe6", "session_id": "1", "device_id": "0FBCA6", "status": "active", "start_time": "2021-03-02T12:55:13Z", "finish_time": "", "finish_reason": "" } ]} 状态码为400时 { "error_code" : "string", "error_msg" : "string" }

响应参数 状态码为200时 表2 响应参数 参数 参数类型 描述 count Integer 符合条件的所有渲染任务的数量。 render_tasks Array of objects 渲染任务信息列表，详情请参见表3。 表3 render_task字段数据结构说明 参数 参数类型 描述 task_id String 任务ID。 连接任务的唯一标识，格式为UUID。 application_id String 应用ID。 应用的唯一标识，格式为UUID。 server_id String 云服务器ID。 云服务器的唯一标识，格式为UUID。 session_id String 会话ID，提供音视频流的会话ID。 普通型云服务器该ID为空。 会话型云服务器该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类型。 status String 任务状态。 status的取值范围如下： active：运行中的任务。 finish：已经结束运行的任务。 start_time String 任务开始时间。 时间格式例如：2020-05-20T03:30:52Z finish_time String 任务结束时间。 时间格式例如：2020-05-20T03:30:52Z finish_reason String 任务结束原因。 finish_reason的取值范围如下： cancel：主动停止任务。 normal：任务正常结束。 error：出现故障，任务结束。 server_deleted：云服务器删除，任务结束。 application_start_failed：启动应用失败，任务结束。 device_changed：修改设备，任务结束。 状态码为400时 表4 响应参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

请求参数 表1 查询参数 参数 是否必选 参数类型 描述 status 否 String 任务状态。 status的取值范围如下： active：运行中的任务。 finish：已经结束运行的任务。 initial：正在初始化的任务。 clean：正在转储中的任务。 application_id 否 String 根据应用ID进行精确搜索。 获取指定应用ID下的渲染任务列表。 server_id 否 String 根据云服务器ID进行精确搜索。 获取指定云服务器上的渲染任务。 device_id 否 String 根据设备ID进行精确搜索。 获取指定设备的渲染任务列表。 limit 否 Integer 每页显示的条目数量。 默认为1000，最大值为1000。 offset 否 Integer 偏移量，表示从此偏移量开始查询。 默认为0，最大值为1000。

API概览 通过使用VR云渲游所提供的接口，您可以完整地使用VR云渲游的所有功能。 VR云渲游终端节点提供的具体API如表1所示。 表1 接口说明 子类型 说明 渲染节点调度 一般由设备调用，用于获取可以连接的GPU云服务器的IP地址等信息。 停止渲染任务 当用户头显处于连接中状态（运行VR或者3D应用）时，调用此接口，会使当前连接断连，即渲染任务停止。 获取渲染任务列表 获取渲染任务列表。 仅支持查询90天内的渲染任务信息。 获取应用列表 获取应用列表，可查看应用基本信息，如应用安装包。 其中，应用的安装包信息受限于集群所选择的区域，因此不会返回当前集群所在区域以外其他区域的安装包信息。 创建应用 创建一个应用，应用会自动安装到选择的云服务器上。 创建应用时，应用安装包区域需在当前集群区域范围内，若为VR应用或非预装的3D应用，需至少选择一个区域的安装包，选择了安装包的区域才能配置该区域的云服务器。预装的3D应用配置云服务器时无安装包区域限制。 一个用户最多创建500个应用。 修改应用安装包 修改指定应用的安装包。修改完成后，该应用安装包区域下的相关云服务器将重新下载安装包进行安装。 已预装的3D应用不支持调用该API修改安装包。 删除应用 删除应用。执行删除操作后，将从云服务器中卸载该应用。 获取指定云服务器上的应用列表 获取指定云服务器上的应用列表，包括需要安装和已经安装的应用。 获取云服务器列表 获取云服务器列表。

错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 CVR.0001 Format of the request body is error. 消息体格式错误 请确认消息体格式是否为json格式 400 CVR.0002 The page limit is error. It can only be [1-1000]. limit格式错误，取值范围为[1-1000] 请确认limit参数在1-1000范围内 400 CVR.0003 The page offset is error. It can only be [0-1000]. offset错误，取值范围为[0-1000] 请确认offset参数在1-1000范围内 400 CVR.0004 Application name is error. It cannot be empty, and can only contain chinese and [a-zA-Z0-9._-]. 应用名称格式错误，不能为空，且只允许输入中文，英文大小写，数字和._- 请更换应用名称 400 CVR.0005 Device ID is error. It can only contain [a-zA-Z0-9_-]. 设备ID格式错误，只允许输入大小写英文，数字和_- 请更换设备ID 400 CVR.0009 Project ID is error. It can only contain [a-f0-9-]. 项目ID格式错误，只允许输入小写英文a-f，数字和- 请确认传入的项目ID是否正确 400 CVR.0010 Application ID is error. It can only contain [a-f0-9-]. 应用ID格式错误，只允许输入小写英文a-f，数字和- 请确认传入的应用ID是否正确 400 CVR.0012 The resource id(cluster id, application id or server id) is not found. 指定资源ID错误，未找到（集群ID，应用ID，云服务器ID） 请确认传入的资源ID是否正确 400 CVR.0013 The application has no idle servers with plugins installed. 指定应用下没有插件已安装完成的闲置云服务器 当前无可用云服务器，请稍后再试 400 CVR.0014 It reaches the connection limit of the master, please upgrade master type or try after a moment. 当前集群连接数已到上限，请稍后再连或者升级集群规格 请稍后再试或者升级集群规格 400 CVR.0016 This device is forbidden in this application. 指定应用的连接策略禁止您的设备连接 请修改应用的连接策略 400 CVR.0024 Task ID is error. It can only contain [a-f0-9-]. 任务ID格式错误，只允许输入小写英文a-f，数字和- 请确认传入的任务ID是否正确 400 CVR.0025 Task ID is error, specified task is not found. 任务ID错误，未找到指定任务 请确认传入的任务ID是否正确 400 CVR.0030 Device brand is error. It can only contain [a-zA-Z0-9 _-]. 设备品牌格式错误，只允许输入英文大小写，数字和空格_- 请确认设备品牌是否正确 400 CVR.0034 Server ID is error. It can only contain [a-f0-9-]. 云服务器ID格式错误，只允许输入小写英文a-f，数字和- 请确认传入的云服务器ID是否正确 403 CVR.0036 Forbidden, project_id is error 鉴权失败，项目ID错误 请确认传入的项目ID是否是API调用区域的 403 CVR.0037 Token is expired. Token过期 请重新获取Token 403 CVR.0039 Token role is forbidden to perform this action. Token权限不足 请授予Tenant Administrator、Tenant Guest和IAM ReadOnlyAccess权限后再重新获取Token 500 CVR.0041 Generate linked token failed 连接Token生成失败 内部错误，请稍后重试或联系技术支持 400 CVR.0055 Policy is not formatted correctly. 策略规则格式错误 请确认传入的policy参数是否正确 400 CVR.0056 The policy type of application is error. It can only be white_list or black_list. 策略类型格式错误，只允许输入[white_list,black_list] 请确认传入的policy type是否正确 400 CVR.0058 Only task status in ['initial', 'active', 'error'] can be stopped. 只能停止[initial, active, error]状态的任务 请确认任务状态是否正确 500 CVR.0060 System error, please try again later or contact customer service. 系统错误，请稍后重试或联系客服 请稍后重试或联系技术支持 400 CVR.0091 Application name already exists. 应用名称已存在 请更换应用名称 400 CVR.0093 Server name is error. It can only contain chinese and [a-zA-Z0-9._-]. 云服务器名称格式错误，只允许输入中文，英文大小写，数字和._- 请确认传入的云服务器名称是否正确 400 CVR.0094 IP address is error. IP地址输入错误 请确认传入的IP地址是否是正确格式 400 CVR.0095 Server status must in ['ACTIVE', 'SHUTOFF', 'BUILD', 'ERROR']. 云服务器状态必须是['ACTIVE', 'SHUTOFF', 'BUILD', 'ERROR']之一 请确认传入的云服务器状态是否正确 400 CVR.0100 The format of description is wrong. 描述信息的格式有误 请确认传入的description参数是否正确 400 CVR.0102 The number of applications exceeds the limit. 应用创建数量已超出上限 请联系技术支持 400 CVR.0107 Must select at least one installation package, the regions of packages must in the regions of current cluster, and packages must be formatted correctly. 需至少选择一个安装包，安装包区域需为当前集群区域内，且安装包格式正确 请确认传入的应用安装包信息是否正确 400 CVR.0109 Must select at least one server. 至少要选择一台云服务器 请确认传入参数中已有云服务器字段是否为空 400 CVR.0113 archive_data must in [true, false]. archive_data必须是[true, false]之一 请确认传入的archive_data参数是否正确 400 CVR.0117 link_status must in ['free', 'error', 'use', 'lost', 'init']. link_status必须是['free', 'error', 'use', 'lost', 'init']之一 请确认传入的link_status参数是否正确 400 CVR.0152 Cannot perform the action,the status of application is abnormal. 应用状态异常，不能进行相关应用操作 当前应用处于修改中等中间状态或异常状态，请等待应用状态恢复正常后再进行相关操作或联系技术支持 400 CVR.0160 Application status is wrong，please use the right status to search your applications. 应用状态参数错误，请使用正确的应用状态进行应用搜索 请确认传入的应用状态是否正确 400 CVR.0193 IES id is wrong. 边缘小站ID参数错误 请确认传入的ID是否正确 400 CVR.0194 No idle servers exists under the specified application or the policy configuration of current device. 当前设备的策略配置下或指定应用下无闲置云服务器 请待有闲置云服务器时再重新尝试 400 CVR.0195 Location is not formatted correctly. 调度区域传参错误 请确认传入的调度区域是否正确 400 CVR.0196 No idle servers exists under regions or available zones of location. 指定location中区域或边缘小站下无闲置云服务器 修改location中指定的区域或边缘小站，或购买新的云服务器 400 CVR.0207 Task status is error. It can only be [initial, active, clean, error, finish]. 任务状态错误，只能是initial, active, clean, error, finish 请确认传入的任务状态是否正确 400 CVR.0223 Servers cannot be configured in a region where the installation package is not selected. 未选择安装包的区域不能配置云服务器 请确认云服务器所在区域已经选择安装包 400 CVR.0225 The current user has no cluster, or the cluster status is not running. 当前用户下无集群，或集群状态不为运行中。 请确认当前用户已经创建集群，且集群处于运行中 400 CVR.0226 The content of existed_servers is not formatted correctly. 使用已有云服务器信息格式错误 请确认云服务器信息是否json格式 400 CVE.0227 Cannot delete application, the application has uncompleted Yearly/Monthly order. 该应用有未完成的包周期订单，暂不支持删除应用 若包周期订单待支付，请取消订单后再执行删除应用操作；若包周期订单处理中，请等待订单处理完成后，再执行删除应用操作 400 CVR.0228 The installation package does not exist. 安装包不存在 请确认安装包参数是否为空 400 CVR.0229 Only one application can be installed on a VR server which has multiple sessions. 多路VR应用服务器只允许安装一个VR应用 请选择单路会话的云服务器进行应用安装 400 CVR.0230 The server with type being switched or switched failed does not support the current operation. 正在切换类型或切换类型失败的云服务器不支持当前操作 请等待类型切换结束，或者选择类型正常的云服务器进行相关操作 400 CVR.0233 The type of application is error. It can only be ['vr', '3d']. 应用类型错误，必须是['vr', '3d']之一 请确认传入的应用类型是否正确 400 CVR.0234 Application launch path must be provided for 3D applications. 3D应用必须提供应用启动路径 若需创建3D应用，请输入应用启动路径 400 CVR.0235 Application launch path is not formatted correctly. 应用启动路径格式错误 请确认传入的应用启动路径格式是否正确 400 CVR.0236 Application launch path must be updated with value. 修改应用启动路径，必须设置路径值（不能为空）。 请输入有效的应用启动路径 400 CVR.0258 Device type is error. It can only be [vr] for VR applications, [pc,mobile,ideahub] for 3D applications. 设备类型错误，VR应用只允许输入[vr]，3D应用只允许输入[pc,mobile,ideahub] 请确认传入的设备类型是否正确 400 CVR.0259 Protocol type is error. It can only be [udp,webrtc,websocket]. 协议类型错误，仅支持[udp,webrtc,websocket] 请确认传入的协议类型是否正确 400 CVR.0260 Application user is error. It can only contain [a-zA-Z0-9_]. 应用使用用户格式错误，只允许输入英文大小写，数字和._- 请确认传入的应用使用用户格式是否正确 400 CVR.0261 The current user or the current device has a render task running under the specified application, and the connected server does not have a public IP. Please stop the task and then reconnect. Task id is %(task_id)s. 当前用户或当前设备在指定应用下存在一个渲染任务，请先停止这个任务后重新连接，任务ID为(task_id) 请调用停止渲染任务API停止原有的渲染任务 400 CVR.0262 The current user or the current device has a render task being dumped under the specified application. Please reconnect after the dump is complete. 当前用户或当前设备在指定应用下存在一个转储中的渲染任务，请等待转储完成后重新连接 请等待转储完成后重新连接 400 CVR.0263 The current user or the current device has a render task running under the specified application. Please stop the task and then reconnect. Task id is %s. 当前用户或当前设备在指定应用下存在一个渲染任务，请先停止这个任务后重新连接，任务ID为(task_id) 请停止渲染任务后重新连接 400 CVR.0264 Start application failed. Please reconnect. 启动应用失败，请重新连接 请根据失败原因查看解决方案，解决问题后重新连接 400 CVR.0266 The current user or the current device has a render task running under the specified application in region %s. Task id is %s. 当前用户或当前设备在指定应用下存在一个其它区域的渲染任务，区域为(region)，任务ID为(task_id)。 请停止其它区域的渲染任务后重新连接 400 CVR.0282 Application launch args is not formatted correctly. 应用启动参数格式错误 请确认传入的应用启动参数格式是否正确 400 CVR.0284 Session hold time is not formatted correctly.It can only be an integer in the range of [-1, 1-30]. 会话保持时间格式错误，只允许输入整数,取值范围为[-1,1-30] 请确认传入的会话保持时间格式是否正确 400 CVR.0291 The number of sessions can be changed only when the link status of server is free. 只有连接状态为闲置的云服务器才允许变更会话路数 请确认云服务器的连接状态是否为闲置。 400 CVR.0296 Cannot update the packages of 3D applications which have be preinstalled in the image. 原镜像预装的3d应用暂不支持修改安装包 若需使用非预装的应用，请重新创建应用选择安装包进行安装 400 CVR.0387 Resolution is error. It can only be [480p, 540p, 720p, 1080p, 2k, 4k]. 分辨率错误，取值只能是[480p, 540p, 720p, 1080p, 2k, 4k]。 请确认传入的分辨率参数是否正确 400 CVR.0388 GPU IP type is error. It can only be [public, private]. 云服务器IP类型错误，取值只能是[public, private] 请确认传入的云服务器IP类型参数是否正确 400 CVR.0392 Cannot perform the action, the current server is creating images. 当前云服务器正在创建镜像，不能进行相关操作 请等待镜像创建完成后重试 400 CVR.0408 The number of sessions can be changed only for VR servers with [2,4,8] sessions. 只有会话路数为[2,4,8]的VR应用云服务器，才能修改会话路数 请确认VR应用云服务器当前的会话路数是否为[2,4,8] 400 CVR.0409 The number of sessions can only be [2,4,8] for VR servers. VR应用云服务器的会话路数只允许为[2,4,8] 请确认VR应用云服务器设置的会话路数是否为[2,4,8] 400 CVR.0410 The number of sessions is error. 3D应用云服务器的会话路数错误 请确认3D应用云服务器设置的会话路数是否为[1,2] 父主题： 附录

状态码 正常 返回值 类型 说明 200 OK GET、PUT、POST操作正常返回 204 No Content DELETE操作正常返回 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 500 Internal Server Error 请求未完成。服务异常。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 附录

响应参数 状态码为200时 表2 响应Body参数 参数 参数类型 描述 applications Array of objects 应用列表信息，详情请参见表3。 表3 application字段数据结构说明 参数 参数类型 描述 id String 应用ID。 应用的唯一标识，格式为UUID。 name String 应用名称。 status String 云服务器上应用的安装状态。 安装状态枚举值： waitinstall：等待安装 installing：安装中 failure：安装失败 launch：运行中 unlaunch：未运行 create_time String 应用创建时间。 时间格式例如：2020-05-20T03:30:52Z package_size String 在云服务器上应用的安装包大小。 install_progress String 在云服务器上应用的安装任务进度。 如：0.86 说明：总进度为1。 状态码为400时 表4 响应Body参数 参数 参数类型 描述 error_code String 返回的错误码，如CVR.0001。 error_msg String 错误的英文描述。

响应示例 状态码为200时 OK { "applications":[ { "id": "4d00636c-6540-11eb-b54a-fa1640a9b002", "name": "testcxcx", "status": "unlaunch", "create_time": "2021-02-02T10:20:42Z", "package_size": "99.27MB", "install_progress": "0.56" }} 状态码为400时 { "error_code" : "string", "error_msg" : "string" }

身份认证与访问控制 统一身份认证 （Identity and Access Management，简称IAM）是华为云提供权限管理的基础服务，可以帮助用户安全地控制云服务和资源的访问权限。 企业路由器支持通过IAM权限策略进行访问控制。IAM权限是作用于云资源的，IAM权限定义了允许和拒绝的访问操作，以此实现云资源权限访问控制。 管理员创建IAM用户后，需要将用户加入到一个用户组中，IAM可以对这个组授予ER所需的权限，组内用户自动继承用户组的所有权限。 IAM的详细介绍，请参见IAM功能介绍。 ER所需的权限，请参见权限管理。 父主题： 安全

管理简单 企业路由器可以在接入的所有网络实例之间路由流量，可以简化网络拓扑，降低网络管理难度，提升网络运维效率。可以减少的工作说明如下： 对于VPC互通，不再需要您频繁创建多个VPC对等连接，维护每个VPC路由表。 对于VPC和DC/VPN互通，不用接入多条线路，多个VPC可以共享专线/VPN。 企业路由器支持路由学习，能够自动进行路由信息的更新和同步，当网络拓扑变更时，能够自动收敛，无需手工配置、变更繁琐的路由条目。