更新时间:2021-11-25 GMT+08:00
分享

修改应用安装包

功能介绍

修改指定应用的安装包。修改完成后,该应用安装包区域下的相关云服务器将重新下载安装包进行安装。

已预装的3D应用不支持调用该API修改安装包。

URI

PUT /v2/cvr/applications/{application_id}/packages

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

表1 路径参数

参数

是否必选

参数类型

描述

application_id

String

应用ID。

请求参数

表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时
    表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

    错误的英文描述。

请求示例

  • 请求URL示例
    PUT https://{endpoint}/v2/cvr/applications/{application_id}/packages
  • 请求示例
    修改应用“北京四”区域的安装包。
    { 
        "package_list":[
            {
    	    "bucket_name": "cvr1",
    	    "package_name": "1.zip",
    	    "bucket_region": "cn-north-4"
    	}
        ],
        "archive_data": false
    }

响应示例

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

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品