更新时间:2025-01-03 GMT+08:00

修改应用

功能介绍

修改应用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PATCH /v1/{project_id}/app-center/apps/{app_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

app_id

String

应用ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

应用名称,名称需满足如下规则:

  1. 名称允许可见字符或空格,不可为全空格。

  2. 长度1~128个字符。

version

String

版本号。

description

String

描述。

app_file_store

FileStoreLink object

文件存储路径支持OBS或者外部链接,store_type指定实际生效的配置,bucket_store和file_link必须设置其一。

app_icon_url

String

图片的路径,支持使用可访问的URL地址或DataURIscheme。

  • 可访问的URL - https://xxx.x.xx.x/xxx/xx.jpg。

  • DataURIscheme - data;image/png;base64,iVBORw0KGgoAAAANS; 注意使用dataURLStream时,最多支持约xxKB大小的图片,且必须是png格式。

install_type

String

安装方式:

  • QUIET_INSTALL - 静默安装。

    安装命令(静默安装命令),例: ${FILE_PATH} /S。

  • UNZIP_INSTALL - 解压安装。

    例: unzip ${FILE_PATH}。

  • GUI_INSTALL - 用户通过GUI界面安装。

    install_type为QUIET_INSTALL、UNZIP_INSTALL时install_command非空。

    预定义变量将采用以下值:

    ${FILE_PATH}: 应用安装包在桌面本地的存储路径。

authorization_type

String

  • ALL_USER - 全部用户

  • ASSIGN_USER - 授权指定用户

install_command

String

安装命令(静默安装命令)。

例: ${FILE_PATH} /S。

预定义变量将采用以下值:

${FILE_PATH}: 应用安装包在桌面本地的存储路径。

uninstall_command

String

卸载命令(静默卸载命令)。

例: msiexec /uninstall ${FILE_PATH} /quiet。

预定义变量将采用以下值:

${FILE_PATH}: 应用安装包在桌面本地的存储路径。

support_os

String

系统类型:

  • Linux -

  • Windows -

  • Other -

catalog_id

String

分类ID。

status

String

应用状态(正常、禁用)

  • 'NORMAL' - 正常

  • 'FORBIDDEN' - 禁用状态

install_info

String

安装信息。

表5 BucketStore

参数

是否必选

参数类型

描述

bucket_name

String

桶名称固定格式:wks-appcenter-{project_id};

需先调用桶授权接口进行授权。

bucket_file_path

String

OBS对象路径。

注: bucket_file_path是对象在obs中的完整路径,不能以/开头。

例如桶存在如下目录结构的数据。

Bucket:

├─dir1

| ├─object1.txt

| └─object2.txt

└─object3.txt

Object1的路径: dir1/object1.txt

Object2的路径: dir1/object2.txt

Object3的路径: object3.txt

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

id

String

唯一标识。

tenant_id

String

租户id。

name

String

应用名称。

version

String

版本号。

description

String

描述。

authorization_type

String

  • ALL_USER - 全部用户

  • ASSIGN_USER - 授权指定用户

app_file_store

FileStoreLink object

应用存储信息。

app_icon_url

String

应用图标路径。

install_type

String

安装方式:

  • QUIET_INSTALL - 静默安装。

    安装命令(静默安装命令),例: ${FILE_PATH} /S。

  • UNZIP_INSTALL - 解压安装。

    例: unzip ${FILE_PATH}。

  • GUI_INSTALL - 用户通过GUI界面安装。

    install_type为QUIET_INSTALL、UNZIP_INSTALL时install_command非空。

    预定义变量将采用以下值:

    ${FILE_PATH}: 应用安装包在桌面本地的存储路径。

install_command

String

安装命令(静默安装命令)。

例: ${FILE_PATH} /S。

预定义变量将采用以下值:

${FILE_PATH}: 应用安装包在桌面本地的存储路径。

uninstall_command

String

卸载命令(静默卸载命令)。

例: msiexec /uninstall ${FILE_PATH} /quiet。

预定义变量将采用以下值:

${FILE_PATH}: 应用安装包在桌面本地的存储路径。

support_os

String

系统类型:

  • Linux -

  • Windows -

  • Other -

status

String

应用状态(正常、禁用)

  • 'NORMAL' - 正常

  • 'FORBIDDEN' - 禁用状态

application_source

String

应用来源:

  • CUSTOM - 用户上传

  • SYSTEM - 内置应用

  • MARKET - 市场应用

create_time

String

应用创建时间。

catalog_id

String

分类ID。

catalog

String

分类名称。

install_info

String

安装信息。

表8 BucketStore

参数

参数类型

描述

bucket_name

String

桶名称固定格式:wks-appcenter-{project_id};

需先调用桶授权接口进行授权。

bucket_file_path

String

OBS对象路径。

注: bucket_file_path是对象在obs中的完整路径,不能以/开头。

例如桶存在如下目录结构的数据。

Bucket:

├─dir1

| ├─object1.txt

| └─object2.txt

└─object3.txt

Object1的路径: dir1/object1.txt

Object2的路径: dir1/object2.txt

Object3的路径: object3.txt

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

{
  "name" : "notepad++.exe",
  "version" : "v1.1.1",
  "description" : "xxx。",
  "app_file_store" : {
    "store_type" : "OBS",
    "bucket_store" : {
      "bucket_name" : "wks-appcenter-xxxx",
      "bucket_file_path" : "app-file/xxxx.exe"
    },
    "file_link" : "https://host-addresss/xxxxx.jpg"
  },
  "app_icon_url" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8 /w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
  "install_type" : "QUIET_INSTALL",
  "authorization_type" : "ALL_USER",
  "install_command" : "${FILE_PATH} /S",
  "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet",
  "support_os" : "Windows",
  "catalog_id" : "xxxx-xxx-xxxx",
  "status" : "NORMAL",
  "install_info" : "xxxx-xxx-xxxx"
}

响应示例

状态码: 200

成功响应。

{
  "id" : "x-xx-xxx",
  "tenant_id" : "xxx-xx-x-xx",
  "name" : "xxx.exe",
  "version" : "v1.1.1",
  "description" : "测试应用。",
  "authorization_type" : "ALL_USER",
  "app_file_store" : {
    "store_type" : "OBS",
    "bucket_store" : {
      "bucket_name" : "wks-appcenter-xxxx",
      "bucket_file_path" : "app-file/xxxx.exe"
    },
    "file_link" : "https://host-addresss/xxxxx.jpg"
  },
  "app_icon_url" : "https://host-addresss/xxxxx",
  "install_type" : "QUIET_INSTALL",
  "install_command" : "${FILE_PATH} /S",
  "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet",
  "support_os" : "Windows",
  "status" : "NORMAL",
  "application_source" : "CUSTOM",
  "create_time" : "2024-12-25T06:58:19.765Z",
  "catalog_id" : 1,
  "catalog" : "其他",
  "install_info" : "安装信息"
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码