修改自定义应用图标 - UploadAppIcon

功能介绍

修改自定义应用图标。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

workspace:app:uploadIcon

Write

app *

-

-

-

appGroup *

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:app:uploadIcon	Write	app *	-	-	-
appGroup *	-

URI

POST /v1/{project_id}/app-groups/{app_group_id}/apps/{app_id}/icon

表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 FormData参数
参数	是否必选	参数类型	描述
data	否	File	应用图标，png格式，限制大小8KB。
icon_url	否	String	base64编码后的png格式图标。

响应参数

状态码：200

表4 响应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	String	发布时间。
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	自定义应用业务扩展信息。

表5 AppExtendedInfo
参数	参数类型	描述
extended_info	Map<String,String>	扩展信息的键值对映射

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：415

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

POST /v1/a4da8115c9d8464ead3a38309130523f/app-groups/575772274859184144/apps/575772274dd859184144/icon

{
  "data" : "file"
}

响应示例

状态码：200

成功响应。

{
  "id" : "1",
  "name" : "Chrome",
  "version" : "99.0.4844.51",
  "command_param" : "",
  "execute_path" : "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe",
  "work_path" : "C:\\Users\\zhangSan\\AppData\\Local\\Google\\Chrome",
  "icon_path" : "C:\\Users\\zhangSan\\AppData\\Local\\Google\\Chrome.png",
  "icon_index" : 1,
  "description" : "Google浏览器",
  "app_group_id" : "1",
  "state" : "NORMAL",
  "tenant_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
  "publish_at" : "2022-03-07T10:40:43.858Z",
  "source_type" : 2,
  "publisher" : "Google Chrome",
  "icon_url" : "https://workspace*****.obs.cn-north-**.myhuaweicloud.com/1.png",
  "publishable" : false,
  "sandbox_enable" : false
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
415	请求中提交的资源格式不支持。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。