获取应用列表

功能介绍

获取应用列表，可查看应用基本信息，如应用安装包。

其中，应用的安装包信息受限于集群所选择的区域，因此不会返回当前集群所在区域以外其他区域的安装包信息。

例如，当前集群所在的区域为“北京四”，则根据“获取应用列表”接口查询到的应用安装包信息只显示“北京四”的，不显示“上海一”的。

URI

GET /v2/cvr/applications

该接口需要使用global终端节点调用。

请求参数

响应参数

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

请求示例

• 请求示例
  假设根据应用名称name进行模糊搜索，获取最新创建的10个应用信息。

  GET https://{endpoint}/v2/cvr/applications?offset=0&limit=10&name=appname

响应示例

• 状态码为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" 
  }

状态码

请参见状态码。

错误码

请参见错误码。