创建应用
功能介绍
创建一个应用,应用会自动安装到选择的云服务器上。
创建应用时,应用安装包区域需在当前集群区域范围内,若为VR应用或非预装的3D应用,需至少选择一个区域的安装包,选择了安装包的区域才能配置该区域的云服务器。预装的3D应用配置云服务器时无安装包区域限制。
一个用户最多创建500个应用。
URI
POST /v2/cvr/applications
该接口需要使用global终端节点调用。
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
application |
是 |
Object |
应用信息,详情请参见表2。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
应用名称。 取值范围:
|
type |
否 |
String |
应用类型。
默认VR应用。 |
session_hold_time |
否 |
Integer |
会话保持时间,单位分钟(min)。 设备断开连接后,会话仍处于正常状态,直到超过会话保持时间。 取值范围:
默认会话保持时间3分钟。 |
launch_path |
否 |
String |
应用启动路径。 取值范围:
约束:
|
description |
否 |
String |
应用描述。 取值范围:
|
package_list |
否 |
Array of objects |
应用安装包列表,详情请参见表3。 约束:
|
policy |
否 |
Object |
策略规则,详情请参见表4。
默认黑名单。 |
existed_servers |
是 |
Array of objects |
应用需要部署的云服务器信息列表,详情请参见表5。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
bucket_name |
是 |
String |
安装包所在OBS桶名称。 示例:cloudvr |
package_name |
是 |
String |
安装包名称。 示例:cvrapp.zip |
bucket_region |
是 |
String |
OBS桶所在区域。 示例:cn-north-4 |
响应参数
- 状态码为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。
- 状态码为400时
表9 响应Body参数 参数
参数类型
描述
error_code
String
返回的错误码,如CVR.0001。
error_msg
String
错误的英文描述。
请求示例
- 请求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" }
状态码
请参见状态码。
错误码
请参见错误码。