文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 应用管理/ 修改应用信息
更新时间：2025-07-09 GMT+08:00
查看PDF
分享

修改应用信息

功能介绍

编辑修改应用信息。

调试

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

URI

PATCH /v1/{project_id}/app-groups/{app_group_id}/apps/{app_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

app_group_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~64个字符。

version

否

String

应用版本号。

execute_path

否

String

执行路径。

work_path

否

String

应用工作目录。

description

否

String

应用描述。

command_param

否

String

启动命令行参数。

state

否

String

应用状态：

  • NORMAL - 正常状态。

  • FORBIDDEN - 禁用状态。

sandbox_enable

否

Boolean

是否使用沙箱模式运行，取值为：

  • false: 表示不以沙箱模式运行

  • true: 表示以沙箱模式运行

app_extended_info

否

AppExtendedInfo object

自定义应用业务扩展信息。
表4 AppExtendedInfo

参数

是否必选

参数类型

描述

extended_info

否

Map<String,String>

扩展信息的键值对映射

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

id

String

应用ID。

name

String

应用名称。

version

String

应用版本号。

command_param

String

启动命令行参数。

execute_path

String

执行路径。

work_path

String

应用工作目录。

icon_path

String

应用图标的路径。

icon_index

Integer

应用图标的索引。

description

String

应用描述。

app_group_id

String

应用组标识Id。

state

String

应用状态：

  • NORMAL - 正常状态。

  • FORBIDDEN - 禁用状态。

tenant_id

String

所在的租户ID。

publish_at

DateTime

发布时间。

source_type

Integer

应用类型：

  • '1':系统内置应用

  • '2':镜像应用

  • '3':自定义应用

publisher

String

应用发布者。

icon_url

String

图标url。

publishable

Boolean

是否可发布应用：

  • true: 可发布。

  • false: 不可发布。

sandbox_enable

Boolean

是否使用沙箱模式运行，取值为：

  • false: 表示不以沙箱模式运行。

  • true: 表示以沙箱模式运行。

is_pre_boot

Boolean

是否开启应用预开，取值为：

  • false: 表示关闭应用预开。

  • true: 表示开启应用预开。

app_extended_info

AppExtendedInfo object

自定义应用业务扩展信息。
表6 AppExtendedInfo

参数

参数类型

描述

extended_info

Map<String,String>

扩展信息的键值对映射

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：405

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：409

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：503

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-groups/656582710889807872/apps/656599335839993860

{
  "version" : "19.0.0.1",
  "description" : "修改应用。",
  "sandbox_enable" : false,
  "name" : "7-Zip File Manager",
  "work_path" : "C:\\Program Files\\7-Zip",
  "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe",
  "command_param" : ""
}

响应示例

状态码：200

成功响应。

{
  "id" : "656599335839993860",
  "name" : "7-Zip File Manager",
  "version" : "19.0.0.1",
  "command_param" : "",
  "execute_path" : "C:\\Program Files\\7-Zip\\7zFM.exe",
  "work_path" : "C:\\Program Files\\7-Zip",
  "icon_path" : "C:\\Program Files\\7-Zip\\7zFM.exe",
  "icon_index" : 0,
  "description" : "",
  "app_group_id" : "656582710889807872",
  "state" : "NORMAL",
  "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011",
  "publish_at" : "2024-01-15T08:39:56.265Z",
  "source_type" : 2,
  "publisher" : "Igor Pavlov",
  "sandbox_enable" : false
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

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

409

操作存在的资源冲突。

500

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

503

服务不可用。

错误码

请参见错误码。

父主题： 应用管理

相关文档