华为云用户手册

响应示例 状态码：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 }

请求示例 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 表4 响应Body参数 参数 参数类型 描述 desktop_used_info_list Array of DesktopUsedHoursInfo objects 桌面使用信息（以桌面Id划分）。 total_count Integer 总数。 表5 DesktopUsedHoursInfo 参数 参数类型 描述 desktop_id String 桌面Id。 desktop_username String 使用的用户。 used_info_list Array of DesktopUsedInfo objects 桌面使用时间列表。 表6 DesktopUsedInfo 参数 参数类型 描述 date String 日期，格式：yyyy-MM-dd（UTC时间）。 use_time String 总共在线时间单位:小时数（h）,精确到两位小数，如：1.32。 状态码：default 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码：200 查询使用桌面的时长响应。 { "desktop_used_info_list" : [ { "desktop_id" : "c6e6dbd7-c950-471d-a6a7-01d0fb62f450", "used_info_list" : [ { "date" : "2022-12-09", "use_time" : 12.62 }, { "date" : "2022-12-10", "use_time" : 2.62 }, { "date" : "2022-12-11", "use_time" : 1.02 }, { "date" : "2022-12-12", "use_time" : 0 }, { "date" : "2022-12-13", "use_time" : 0 }, { "date" : "2022-12-14", "use_time" : 3.87 }, { "date" : "2022-12-15", "use_time" : 3.56 } ] }, { "desktop_id" : "d5367f84-1d64-498e-9b92-093002ac6ce9", "used_info_list" : [ { "date" : "2022-12-09", "use_time" : 10.56 }, { "date" : "2022-12-10", "use_time" : 1.38 }, { "date" : "2022-12-11", "use_time" : 0 }, { "date" : "2022-12-12", "use_time" : 0 }, { "date" : "2022-12-13", "use_time" : 0 }, { "date" : "2022-12-14", "use_time" : 3.87 }, { "date" : "2022-12-15", "use_time" : 3.56 } ] } ], "total_count" : 2 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 桌面id集合。 start_time 否 String 开始时间，格式：yyyy-MM-dd（UTC时间，不传查默认最近15天）最多查31天数据。 end_time 否 String 结束时间，格式：yyyy-MM-dd（UTC时间，不传查默认最近15天）最多查31天数据。 group_by_type 否 String 统计方式，不传则默认按天。可选值为： DAY: 按天。 HOUR: 按小时。 desktop_username 否 String 若传桌面的用户名，则查询使用时间只有该用户的使用时间。 offset 否 Integer 从查询结果中的第几条数据开始返回,用于分页查询，取值范围0-2147483647，默认从0开始。 limit 否 Integer 查询结果中想要返回的信息条目数量,用于分页查询，取值范围0-100，默认值100。

修订记录 发布日期 修订记录 2025-04-23 第二十八次正式发布。 约束与限制新增API接口调用次数说明。 2025-01-09 第二十七次正式发布。 新增： 应用组管理目录下新增应用组删除、查询应用组详情。 应用管理目录下新增查询应用详细信息、删除自定义应用图标、批量禁用应用、批量启用应用。 应用组管理目录下新增解除服务组关联的所有应用组、查询应用组授权邮件发送记录、重发应用组授权邮件（根据授权邮件记录）、重发应用组授权邮件（根据授权记录）。 服务器组管理目录下新增查询租户服务器组基础信息列表、指定租户服务器组限制查询、删除弹性伸缩策略、查询服务器组弹性伸缩策略、新增/修改弹性伸缩策略。 服务器管理目录下新增删除服务器、查询指定服务器、查询租户的所有HDA最新版本、批量升级服务器HDA版本、批量升级服务器HDA版本、查询租户的HDA最新版本、查询服务器的HDA相关信息、查询服务器的HDA升级跟踪记录、批量修改服务器的镜像、标记服务器维护状态、批量重装服务器、查询云应用服务器监控信息。 任务管理目录下新增子任务查询、批量删除子任务、子任务数量查询。 应用仓库管理目录下新增添加桶或者桶授权。 可用区管理目录下新增查询可用分区列表。 租户配置目录下新增查询企业系统配置、租户服务激活、初始化、查询租户信息。 订单目录及目录下接口。 镜像管理目录下新增查询指定镜像实例。 存储管理目录下新增删除WKS存储、查询SFS3.0存储。 策略管理目录下新增查询策略组详情列表、查询策略组中的策略项、查询策略组详情列表。 定时任务目录下新增查询定时任务列表、新增定时任务、查询定时任务执行子任务列表、删除任务、查询指定定时任务详情、修改定时任务、查询指定定时任务详情、批量删除定时任务、未来执行的具体时间列表。 服务器组标签管理目录下新增查询服务器组的标签、添加服务器组标签、删除服务器组标签、查询租户在所有服务器组上的标签、批量添加服务器组标签、批量删除服务器组标签。 产品套餐管理目录下新增查询会话套餐列表（已废弃）。 2025-01-03 第二十六次正式发布。 新增： 用户操作日志目录及目录下接口。 应用管控目录下新增查询应用分类信息、按照名称分页查询应用、添加应用、批量设置应用授权、批量自动安装应用、批量删除应用、批量设置不可见、批量设置可见、删除应用、修改应用、设置应用授权、自动安装应用、查询应用授权信息、添加并授权默认桶、生成访问凭证信息、查询应用安装job信息、批量删除job、重试失败job等接口。 应用管控目录及目录下接口。 租户配置目录下新增查询认证登录方式、更新认证策略配置、查询租户的NAT映射配置项、修改租户的NAT映射配置项、查询租户功能状态、启禁用租户功能、查询租户个性配置列表、修改租户个性配置等接口。 任务目录下新增查询可用分区详情、查询可用分区列表概要等接口。 连接信息目录下新增查询桌面登录状态、查询登录人数、查询桌面登录状态等接口。 桌面目录下新增查询桌面监控信息、查询桌面安装agent详情、安装agent、批量分配用户、批量解绑用户、AD场景支持桌面更换关联用户名、桌面转镜像、批量设置桌面维护模式、发送 消息通知 、预批量分配用户、更新桌面SID、修改桌面属性、查询桌面开关机信息、重新加入AD域、查询sysprep版本信息、根据子网id查询该子网下可用的ip等接口 桌面标签目录及目录下接口。 可用分区目录下新增获取云市场镜像列表接口。 询价目录及目录接口。 委托目录下新增查询云办公带宽列表、创建云办公带宽、删除云办公带宽、查询云办公带宽的控制配置、修改云办公带宽的控制配置、修改云办公带宽、查询上网功能、开通上网功能、查询NAT网关列表、查询端口列表、查询正在被使用的子网id列表等接口。 订单目录及目录下接口。 组织单元目录及目录下接口。 策略组目录下新增查询策略组列表、新增策略组、查询策略组详情列表、查询初始策略项、删除策略组、查询策略组、修改策略组、查询策略组中的策略项、修改策略组中的策略项、查询策略组应用对象、修改策略组中的策略项等接口。 镜像目录下新增查询租户单个站点配额详情接口。 报表统计目录下新增获取时区配置接口。 告警目录下新增登录状态统计、运行状态统计、查询指标环比值等接口。 磁盘目录下新增增加桌面磁盘、扩容磁盘、查询磁盘产品信息等接口。 网络目录下新增重试任务、删除子任务等接口。 镜像目录下新增查询脚本执行记录列表、查询脚本执行记录详情、查询脚本任务列表、重试脚本或执行脚本失败的任务、停止脚本或者命令执行任务、查询脚本列表、新增脚本、删除脚本、查询脚本详情、更新脚本等接口。 云办公服务目录下新增查询站点信息、新增站点、删除站点、修改站点接入方式、修改站点业务子网、修改企业ID等接口。 用户目录下新增批量删除用户、重新发送邮件等接口。 2024-12-12 第二十五次正式发布。 新增： 租户配置 桌面标签 组织单元 快照 终端与桌面绑定 询价 脚本 网络 2024-09-05 第二十四次正式发布。 新增： 服务器组标签管理 应用仓库管理 获取VNC远程登录地址 2024-03-20 第二十三次正式发布。 新增： 解绑用户 分配用户 产品套餐 报表统计 2024-01-11 第二十二次正式发布。 新增： 桌面池。 2023-12-18 第二十一次正式发布。 修改： 批量注销桌面接口中的请求示例。 2023-11-29 第二十次正式发布。 修改： 设置终端与桌面绑定的开关配置接口中tc_bind_switch参数的描述。 2023-11-16 第十九次发布。 新增： 批量添加多个桌面标签。 批量删除多个桌面标签。 2023-11-10 第十八次正式发布。 新增： 查询桌面网络。 2023-11-06 第十七次正式发布。 新增： 重建桌面。 2023-10-09 第十六次正式发布。 新增： 策略组。 2023-09-15 第十五次正式发布。 新增： 切换桌面网络。 2023-07-04 第十四次正式发布。 新增： 批量注销桌面、查询在指定时间段未使用的桌面、查询使用桌面的时长、查询用户列表、创建用户组、批量删除用户组、删除用户组、修改用户组信息、操作用户组、查询用户组中的用户接口。 2023-06-20 第十三次正式发布。 新增： 云应用APIAPI参考指导。 云应用错误码。 2023-06-06 第十二次正式发布。 修改： 创建桌面章节中email_notification参数的描述。 2022-12-23 第十一次正式发布。 修改： 连接信息下各接口新增请求及响应示例。 2022-12-20 第十次正式发布。 新增： 用户组。 2022-12-08 第九次正式发布。 修改： 云办公服务中新增查询云办公服务是否被锁定、解除云办公服务锁定状态接口。 新增 查询OTP设备、解绑OTP设备接口。 删除桌面数据盘接口。 桌面标签。 用户。 连接信息。 2022-11-29 第八次正式发布。 修改： 终端节点中新增“西南-贵阳一”和“拉美-圣地亚哥”的终端节点信息。 2022-11-17 第七次正式发布。 删除： 删除“历史API”节点。 2022-11-14 第六次正式发布。 修改： 根据产品规划调整增加桌面磁盘中新增磁盘参数名称，由“addDesktopVolumesReq”变更为“desktop_volumes”。 根据产品规划调整扩容桌面磁盘中扩容磁盘参数名称，由“expandVolumesReq”变更为“desktop_volumes_expansion”。 优化创建用户和查询用户详情信息中时间格式。 新增： 新增“历史API”节点。将原参数名称的“增加桌面磁盘”、“扩容桌面磁盘”API接口归档至历史API节点下。 新增操作用户接口。 2022-10-27 第五次正式发布。 修改： 优化 云桌面 错误码。 2022-09-29 第四次正式发布。 修改： 优化查询产品套餐列表和查询可用分区列表参数描述。 优化云桌面错误码。 2022-09-15 第三次正式发布。 修改： 优化桌面中的示例。 2022-09-02 第二次正式发布。 新增： 变更规格。 2022-08-27 第一次正式发布。

响应示例 状态码：200 成功响应。 { "server_end_point" : "https://obs.cn-nor***huaweicloud.com", "bucket_name" : "wks-app-test123456", "directory" : "file/Postman.exe", "ak" : "5BJ**********30", "sk" : "2yB**********5gt", "policy" : { "version" : "1.1", "statement" : { "effect" : "Allow", "action" : [ "obs:object:putObject", "obs:object:deleteObject" ], "resource" : [ "obs:*:*:object:wks-app-test123456/file/Postman.exe" ] } }, "security_token" : "ggp**********iwi", "expires_at" : "2020-01-08T03:16:01:599000Z" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_file_name 是 String 应用名称,名称需满足如下规则: 文件名前缀由可见字符和空格组成，且不能为全空格。 长度范围1~255个字符。 结尾必须是.msi或者.exe或者.zip或者.rar。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 server_end_point String 访问的服务终端节点。 bucket_name String 存放的桶名称。 directory String 存放目录。 ak String 获取的AK。。 sk String 获取的SK。 expires_at String AK/SK和securitytoken的过期时间。。 policy Policy object ak/sk允许的访问策略。 security_token String 安全校验token，将所获的AK、SK等信息进行加密后的字符串。 表5 Policy 参数 参数类型 描述 version String 版本号。 statement PolicyStatement object OBS桶存放的策略内容。 表6 PolicyStatement 参数 参数类型 描述 effect String 状态(允许、禁用)： Allow - 允许 Deny - 禁用 action Array of strings 可以进行操作的权限合集。 resource Array of strings 允许访问的资源。 状态码：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 错误描述。 状态码：415 表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 错误描述。

响应参数 状态码：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 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of ServerGroupTagsInfo objects 服务器组关联的标签列表。 表4 ServerGroupTagsInfo 参数 是否必选 参数类型 描述 server_group_id 否 String 服务器组唯一标识。 tags 否 Array of TmsTag objects 标签列表。 表5 TmsTag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 两头不能有空白字符。 value 否 String 值。每个值最大长度255个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。

响应参数 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of TmsTag objects 标签列表。 表4 TmsTag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 两头不能有空白字符。 value 否 String 值。每个值最大长度255个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。

请求示例 PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-groups/575772274859184145 { "name" : "开放性API修改应用组测试", "app_server_group_id" : "2ad44c6d-b829-4e89-a44a-5f25577f7788", "description" : "AAAA。" }

响应示例 状态码：200 成功响应。 { "id" : "575772274859184145", "name" : "开放性API修改应用组测试", "app_server_group_id" : "d75cce49-413a-4102-8cfa-c4328f5cac6f", "description" : "AAAA。", "authorization_type" : "APP_GROUP", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "create_at" : "2023-06-06T14:14:02.246Z" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 id String 应用组ID。 name String 应用组名称。 app_server_group_id String 应用服务器组ID。 app_server_group_name String 应用服务器组名称。 description String 应用组描述。 authorization_type String 授权类型，基于应用(组)授权，默认为APP_GROUP授权。 APP - 按照应用授权（尚未支持）。 APP_GROUP - 按照应用组授权。 tenant_id String 租户ID。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app。 COMMON_APP - 普通app。 create_at String 发布时间。 app_count Integer 应用数量。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 应用组名称,名称需满足如下规则: 由中文，英文大小写，数字，_-组成。 长度范围1~64个字符。 app_server_group_id 否 String 应用服务器组ID(仅允许未设置的情形下进行绑定)。 description 否 String 应用组描述。

响应示例 状态码：200 成功响应。 { "id" : 560329060530520064, "name" : "user-file-persistent", "storage_metadata" : { "storage_handle" : "sfs-tmp", "storage_class" : "sfs", "name" : "sfs-tmp", "region" : "cn-north-5", "export_location" : "https://sfs3.cn*****.huaweicloud.com:443" }, "create_time" : "2023-06-08T06:50:39.704Z", "user_claim_count" : 0, "share_claim_count" : 0 }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 id String WKS存储ID。 name String 名称。 storage_metadata StorageMetadata object 存储定义。 create_time String 创建时间。 user_claim_count Integer 个人目录声明数量。 share_claim_count Integer 共享目录声明数量。 表6 StorageMetadata 参数 参数类型 描述 storage_handle String SFS文件系统名称。 storage_class String 存储类型： sfs - sfs3.0存储。 name String 名称。 region String 所在区域。 export_location String 访问地址:protocol://[bucket-name].sfs3.[region-name].myhuaweicloud.com:port。 状态码：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 错误描述。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String WKS存储名称,名称需满足如下规则: 名称允许可见字符或空格，不可为全空格。 长度1~128个字符。 storage_metadata 是 Storage object 存储定义元数据。 表4 Storage 参数 是否必选 参数类型 描述 storage_handle 是 String SFS文件系统名称。 storage_class 是 String 存储类型： sfs - sfs3.0存储。

响应参数 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：409 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求示例 PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-warehouse/apps/5298741256415 { "app_name" : "记事本", "app_category" : "GAME", "os_type" : "Windows", "version_id" : "3.1.2", "app_description" : "XXX公司 XX软件开发应用。", "version_name" : "测试版本", "app_icon" : "a2FybWEK" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 policy_statement_id String 支持的访问策略，内置如下四种策略: DEFAULT_1：客户端访问存储 - 上传、下载; 云端访问存储 - 读写。 action: PutObject、DeleteObject、GetObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_2：客户端访问存储 - 下载; 云端访问存储 - 读写。 action: GetObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_3：客户端访问存储 - 上传; 云端访问存储 - 读写。 action: PutObject、DeleteObject roam_action: PutObject、DeleteObject、GetObject DEFAULT_4：客户端访问存储 - 仅可查看列表,不允许上传下载; 云端访问存储 - 只读。 action: roam_action: GetObject actions Array of strings 客户端访问存储可操作的权限合集。 PutObject - 上传、修改、重命名、移动。 GetObject - 下载。 DeleteObject - 删除。 roam_actions Array of strings 云端访问存储可操作的权限合集。 PutObject - 上传、修改、重命名、移动。 GetObject - 下载。 DeleteObject - 删除。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 actions 否 Array of strings 客户端访问存储可操作的权限合集 允许为空，为空时配置了该策略的用户，通过云办公客户端接入后仅可查看文件列表，不可上传下载。 PutObject - 上传、修改、重命名、移动。 DeleteObject - 删除。 GetObject - 下载。 注：PutObject和DeleteObject必须同时设置,不支持仅设置其中一个。 roam_actions 是 Array of strings 云端访问存储可操作的权限合集，不允许为空。 PutObject - 上传、修改、重命名、移动。 DeleteObject - 删除。 GetObject - 下载 。 注：PutObject和DeleteObject必须同时设置,不支持仅设置其中一个。

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-warehouse/apps { "app_name" : "Postman", "app_category" : "PRODUCTIVITY_AND_COLLABORATION", "os_type" : "Windows", "version_name" : "Canary", "version_id" : "7.9.0.0", "appfile_store_path" : "file/Postman.exe", "app_description" : "A postman setup exe.。", "app_icon" : "data:image/png;base64,iVBORw0KGWBUwmyIgfBRgjsA88DJ9OxpLdgbbFDuB+Pt***********w59LFEQHa+0QrAJNBfiSUVORK5CYII=", "app_file_size" : 401 }

响应示例 状态码：200 成功响应。 { "id" : "694648268272959491", "app_id" : "694648268205850627", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011", "app_name" : "Postman", "app_category" : "PRODUCTIVITY_AND_COLLABORATION", "os_type" : "Windows", "version_id" : "7.9.0.0", "version_name" : "Canary", "appfile_store_path" : "file/Postman.exe", "app_file_size" : "401", "app_description" : "A postman setup exe.。", "create_time" : "2024-05-07T07:16:27.791729999Z", "modify_time" : "2024-05-07T07:16:27.791729999Z", "verify_status" : "VERIFYING", "app_icon" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDP*************ABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAAC" }

响应示例 状态码：200 成功响应。 { "id" : "575768277444198400", "job_type" : "CREATE_SERVER", "begin_time" : "2023-06-06T02:30:06.836Z", "end_time" : "2023-06-06T02:45:49.577Z", "status" : "SUC CES S", "sub_jobs_total" : 1, "sub_jobs" : [ { "id" : "575768277481947136", "job_type" : "CREATE_SERVER", "job_resource_info" : { "resource_id" : "a2a6f5af-cbf7-4242-8988-109426870886", "resource_name" : "APS-20230606023006-YM08IXT04C" }, "begin_time" : "2023-06-06T02:30:06.902Z", "end_time" : "2023-06-06T02:45:49.564Z", "status" : "SUCCESS", "error_code" : "", "error_message" : "", "project_id" : "a4da8115c9d8464ead3a38309130523f", "job_id" : "575768277444198400" } ] }

响应参数 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 服务器组名称，名称需满足如下规则: 由中文，英文大小写，数字，_-组成，不能有空格。 长度范围1~64个字符。 description 否 String 服务器组描述。 route_policy 否 RoutePolicy object 路由策略。 storage_mount_policy 否 String 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 USER - 仅挂载个人目录。 SHARE - 仅挂载共享目录。 ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。 image_id 否 String 服务器组关联的镜像ID，更新镜像ID只对组下新创建的云服务器生效。 image_product_id 否 String 服务器组的镜像的productId。 image_type 否 String 镜像类型： gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他 system_disk_type 否 String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO system_disk_size 否 Integer 磁盘容量，单位GB。 ou_name 否 String 默认组织名称。 app_type 否 String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app server_group_status 否 Boolean 服务器是否处于禁用状态： true - 启用状态 false - 禁用状态 表4 RoutePolicy 参数 是否必选 参数类型 描述 max_session 否 Integer 单台服务器最大的链接会话数。 cpu_threshold 否 Integer cpu使用率阈值，单位为%。 mem_threshold 否 Integer 内存使用率阈值，单位为%。

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 job_id String 增加磁盘任务ID。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：409 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。