华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 否 String 下单类型。 ADD_VOLUME：增加磁盘 EXTEND_VOLUME：扩容磁盘 RESIZE：变更规格 CHANGE_IMAGE：切换镜像 ADD_SUB_RESOUR CES ：购买桌面协同资源 DELETE_SUB_RESOURCES：退订桌面协同资源 add_volume_param 否 EstimateAddVolumeRequestBody object 包周期桌面池添加磁盘、切换镜像询价请求体。 extend_volume_param 否 EstimateExtendVolumeRequestBody object 包周期扩容磁盘询价请求体。 resize_param 否 CreateResizeOrderRequestBody object 包周期变更规格询价请求体。 change_image_param 否 CreateChangeImageOrderRequestBody object 包周期重建系统盘询价请求体。 add_sub_resources_param 否 EstimateAddSubResourcesRequestBody object 包周期新增附属资源询价请求体。 delete_sub_resources_param 否 CreateDeleteSubResourcesOrderRequestBody object 包周期删除附属资源询价请求体。 表4 EstimateAddVolumeRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 volume_type 是 String 新增磁盘类型。 volume_size 是 Integer 新增磁盘大小。 表5 EstimateExtendVolumeRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 desktop_pool_disk_id 是 String 需要扩容的桌面池磁盘ID。 new_size 是 Integer 扩容后的磁盘大小。 表6 CreateResizeOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 product_id 是 String 目标规格产品ID。 mode 否 String 是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP，如果桌面处于开机状态，会先关机再变更规格。 表7 CreateChangeImageOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 image_spec_code 否 String 云市场镜像的specCode，即将停用。image_spec_code与image_id同时存在时取image_id的值，两者不可同时为空。 image_id 否 String 云市场镜像ID，建议使用image_id。 delay_time 否 Integer 立即重建时给用户预留的保存数据的时间（单位：分钟）。 message 否 String 下发重建系统盘任务时，给用户发送的提示信息。 表8 EstimateAddSubResourcesRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 sub_resource_sku 是 String 新增附属资源SKU码。 表9 CreateDeleteSubResourcesOrderRequestBody 参数 是否必选 参数类型 描述 desktop_pool_id 否 String 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 desktop_ids 否 Array of strings 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 promotion_plan_id 否 String 促销计划ID。 sub_resource_type 是 String 待删除附属资源类型：DESKTOP_SHARER(桌面协同资源)。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 server_metrics Array of ServerMetricData objects 监控数据。 表5 ServerMetricData 参数 参数类型 描述 metric_name String 监控指标名称。 datapoints Array of ServerDataPoints objects 指标数据列表。 dimension_value String 维度值，仅查询GPU监控信息时有值。 表6 ServerDataPoints 参数 参数类型 描述 average Double 聚合周期内指标数据的平均值。 max Double 聚合周期内指标数据的最大值。 min Double 聚合周期内指标数据的最小值。 sum Double 聚合周期内指标数据的求和值。 variance Double 聚合周期内指标数据的方差。 timestamp Long 指标采集时间，UNIX时间戳，单位毫秒。 unit 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 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求示例 GET /v1/a4da8115c9d8464ead3a38309130523f/app-servers/server-metric-data/8115c9d8464ead3a38309130?namespace=AGT.E CS &metric_name=cpu_util&from=1691671739879&to=1691671739872&period=1&filter=average

URI GET /v1/{project_id}/app-servers/server-metric-data/{server_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 server_id 是 String 服务器唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 namespace 是 String 服务的命名空间：例如 "SYS.ECS/AGT.ECS"，当namespace为AGT.ECS，则查询GPU监控指标： - SYS.ECS：弹性云服务器的基础监控指标。 - AGT.ECS：弹性云服务器操作系统监控的监控指标（GPU指标）。 metric_name 是 String 监控查询指标名称: - SYS.ECS命名空间的指标名称,请参考帮助文档：“弹性云服务器支持的基础监控指标”。 - AGT.ECS命名空间的指标名称,请参考帮助文档：“操作系统监控指标：GPU”。 from 是 String 查询数据起始时间，UNIX时间戳，单位毫秒。 to 是 String 查询数据截止时间UNIX时间戳，单位毫秒。from必须小于to。 period 是 Integer 监控数据粒度。 取值范围： - 1: 实时数据。 - 300: 5分钟粒度。 - 1200: 20分钟粒度。 - 3600: 1小时粒度。 - 14400: 4小时粒度。 - 86400: 1天粒度。 filter 是 String 数据聚合方式，支持的聚合方式如下: - average：聚合周期内指标数据的平均值。 - max：聚合周期内指标数据的最大值。 - min：聚合周期内指标数据的最小值。 - sum：聚合周期内指标数据的求和值。 - variance：聚合周期内指标数据的方差。

响应示例 状态码： 200 操作成功。 { "server_metrics" : [ { "datapoints" : [ { "average" : 0.23, "timestamp" : 1442341200000, "unit" : "%" } ], "metric_name" : "gpu_usage_encoder", "dimension_value" : "2e84018fc8b4484b94e89aae212fe615" }, { "datapoints" : [ { "average" : 0.23, "timestamp" : 1442341200000, "unit" : "%" } ], "metric_name" : "gpu_usage_encoder", "dimension_value" : "7784018fc8b4484b94e89aae212fe455" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 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参数 参数 是否必选 参数类型 描述 server_ids 是 Array of strings 应用服务器id集合。 host_id 是 String 目标云办公主机id。

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "bc05da52-89df-45ba-8146-13fe3ce7c45a", "name" : "ApiExpirezSr5_1HgOfh56", "description" : "", "image_id" : "6579b42e-f345-4452-ae3a-fa0687564943", "os_type" : "Windows", "product_id" : "workspace.appstream.general.xlarge.2", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "system_disk_type" : "SATA", "system_disk_size" : 60, "is_vdi" : false, "app_type" : "COMMON_APP", "create_time" : "2023-06-06T14:14:36.416Z", "update_time" : "2023-06-06T14:14:38.127Z", "app_server_flavor_count" : 0, "app_server_count" : 0, "app_group_count" : 0, "image_name" : "ApiExplore_Image_01", "product_info" : { "product_id" : "workspace.appstream.general.xlarge.2", "flavor_id" : "s2.large.2", "type" : "BASE", "architecture" : "x86", "cpu" : "2", "memory" : "4096", "is_gpu" : false, "system_disk_type" : "SAS", "system_disk_size" : "80", "descriptions" : "s2.large.2 云应用通用型|2核|4GB内存", "charge_mode" : "0", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 1, "status" : "abandon", "cond_operation_az" : "cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(normal)", "domain_ids" : [ ] }, "subnet_name" : "subnet-config", "ou_name" : "" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ServerGroup objects 服务器组列表，返回列表条目数量上限为分页的最大上限值。 表5 ServerGroup 参数 参数类型 描述 id String 服务器组的唯一标识。 name String 服务器组名称。 description String 服务器组描述。 image_id String 服务器组关联的镜像ID，用于创建对应组下的云服务器。 os_type String 系统类型，当前仅支持Windows。 Linux - Windows - Other - product_id String 产品id。 subnet_id String 网卡对应的子网ID。 system_disk_type String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO system_disk_size Integer 磁盘容量，单位GB。 is_vdi Boolean 是否为vdi单会话模式。 extra_session_type String 付费会话类型： GPU - GPU规格会话。 CPU - 普通CPU规格会话。 extra_session_size Integer 付费会话个数。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app create_time String 服务器组创建时间。 update_time String 服务器组更新时间。 storage_mount_policy String 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 USER - 仅挂载个人目录。 SHARE - 仅挂载共享目录。 ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。 enterprise_project_id String 企业项目ID(0表示默认企业项目Id)。 primary_server_group_ids Array of strings 主服务器组id列表。 secondary_server_group_ids Array of strings 备服务器组id列表。 server_group_status Boolean 服务器是否处于启用状态，true表示处于启用状态 false表示处于禁用状态。 site_type String 站点类型 - CENTER/IES。 site_id String 站点id。 app_server_flavor_count Integer 服务器配置总数量。 app_server_count Integer 服务器总数量。 app_group_count Integer 关联应用组的总数量。 image_name String 镜像名称。 product_info ProductInfo object 产品规格信息。 subnet_name String 子网名称。 scaling_policy ScalingPolicy object 弹性伸缩策略。 tags Array of TmsTag objects 标签信息。 ou_name String 默认组织名称。 表6 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型： BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 ADVANCED：表示产品高级套餐，套餐镜像中包括了一些商业软件。 architecture String 产品架构，当前仅支持x86。 x86 arm cpu String CPU。 cpu_desc String CPU描述。 memory String 内存大小，单位兆：M。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小。 gpu_desc String GPU描述。 descriptions String 产品描述。 charge_mode String 套餐标识。 1：表示包周期。 0：表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘。 resource_type String 资源类型。 cloud_service_type String 云服务类型。 volume_product_type String 磁盘产品类型。 sessions Integer 套餐默认支持的最大会话数。 status String 产品套餐在销售模式下的状态，取值自ECS的cond:operation:status。 不配置时等同于normal在售状态。 normal - 正常商用 abandon - 下线（即不显示） sellout - 售罄 obt - 公测 obt_sellout - 公测售罄 promotion - 推荐(等同normal，也是商用) cond_operation_az String 产品套餐在可用区的状态，配套status使用。 说明： 此参数是AZ级配置，优选取此参数的值，某个AZ没有在此参数中配置时默认使用status参数的取值。 配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。 例如：套餐在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： “status”设置为：“abandon” 。 “cond_operation_az”设置为：“az0(normal), az1(sellout), az2(obt), az3(normal)”。 说明：如果flavor在某个AZ下的状态与status配置状态不同，必须配置该参数。 sub_product_list Array of strings 专属主机的子产品。 domain_ids Array of strings 产品属于专有的domainId。 package_type String 套餐类型： general：表示产品通用套餐。 dedicated：表示产品专属主机套餐。 expire_time String 产品套餐过期时间，产品将在改时间点后逐步下架。 support_gpu_type String 产品套餐支持的GPU类型。 表7 ScalingPolicy 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表8 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到改阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 表9 TmsTag 参数 参数类型 描述 key String 键。最大长度128个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 两头不能有空白字符。 value String 值。每个值最大长度255个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/app-server-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_group_name 否 String 服务器组名称。 server_group_id 否 String 服务器组唯一标识。 app_type 否 String 应用组类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app tags 否 String 查询tag字段中包含该值的服务器组。 enterprise_project_id 否 String 企业项目ID(字段为空或者0表示使用默认default企业项目)。 is_secondary_server_group 否 String 是否为备服务器组，不传默认查所有： true : 是备服务器组。 false: 主服务器组，默认。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PersistentStorageAssignment objects 查询用户存储声明配置。 表5 PersistentStorageAssignment 参数 参数类型 描述 storage_claim_id String WKS存储目录声明ID。 folder_path String 存储对象路径。 注: path是对象在系统中的完整路径。 例如系统中存在如下目录结构的数据。 SFS-Tmp: └─shares ├─image └─video image的路径: shares/image/ video的路径: shares/video/ delimiter String 路径分隔符。 claim_mode String 存储声明的类型： USER - 用户目录 SHARE - 共享目录 storage_metadata StorageMetadata object 存储定义。 policy_statement PolicyStatement object 支持的访问策略。 attachment Attachment object 配置关联成员。 表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。 表7 PolicyStatement 参数 参数类型 描述 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 - 删除。 表8 Attachment 参数 参数类型 描述 attach String 目标。 attach_type String 关联对象类型： USER - 用户 USER_GROUP - 用户组 状态码： 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 错误描述。

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "storage_claim_id" : 544959151881584640, "folder_path" : "shares/video/", "delimiter" : "/", "claim_mode" : "SHARE", "storage_metadata" : { "storage_handle" : "sfs-tmp", "storage_class" : "sfs", "name" : "sfs-tmp", "region" : "cn-north-5", "export_location" : "https://sfs3.cn-north-xx.myhuaweicloud.com:443" }, "policy_statement" : { "policy_statement_id" : "xxxxx-xxx-xx", "actions" : [ "GetObject" ] }, "attachment" : { "attach" : "USER001***@local.com", "attach_type" : "USER" } } ] }

URI GET /v1/{project_id}/persistent-storages/actions/list-attachments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 是 String WKS存储ID。 claim_mode 是 String 存储声明的类型，claim_mode为share时，storage_claim_id必填。 USER - 用户目录 SHARE - 共享目录 storage_claim_id 否 String WKS存储目录声明ID。 attach 否 String 成员。 attach_type 否 String 关联对象类型： USER - 用户 USER_GROUP - 用户组

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of strings 批量唯一标识请求列表，一次请求数量区间 [1, 20]。 recursive 是 Boolean 是否同时删除镜像实例关联资源： ⚠ 警告: 关联资源删除，对应的应用将不可用 true 同时删除关联资源，包括APS服务器组，APS服务器，应用组相关资源。镜像产物相关信息保留。 false 只删除镜像实例记录，保留关联资源。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 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 错误描述。

URI GET /v2/{project_id}/statistics/notification-records 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 metric_name 否 String 指标名称(精确匹配) (metric_name和rule_id不允许同时为空) rule_id 否 String 通知规则ID (metric_name和rule_id不允许同时为空) offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer 单次查询的大小[1-100],默认值10。

响应示例 状态码： 200 成功响应。 { "count" : 20, "items" : [ { "id" : "0a0666f634a54131826bf688058d0bc6", "session_stamp" : "S-1-5-21-1908276142-124560728-768171367-3204-XXXXX@wksapp.huawei.com-HDP-2", "protocol_type" : "HDP", "login_user" : "XXX@wksapp.huawei.com", "session_type" : "2", "app_server_group_id" : "e75fef51-bbb7-489c-b4bd-63e0587faa41", "app_server_group_name" : "TEST-勿动", "pre_conn_time" : "2024-03-13T03:12:47Z", "start_time" : "2024-03-13T03:12:47Z", "machine_sid" : "S-1-5-21-1908276142-124560728-768171367-3204", "machine_name" : "APS-CUY5MR45XX", "session_state" : "AppcInit", "agent_version" : "23.5.0.0606", "vm_ip" : "172.*.*.218", "failed_reason" : "", "failed_code" : "", "tenant_id" : "26a0420e9e284569a23f1b2f7d9b5011" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of SessionInfo objects 企业的会话列表。 表5 SessionInfo 参数 参数类型 描述 id String 主键ID。 session_stamp String 会话标识。 os_session_id String 会话在hda的os中会话id。 protocol_type String 协议类型。 login_user String 当前会话的登录用户。 session_type String 会话类型，1表示共享桌面，2表示应用。 app_server_group_id String AppServer组ID。 app_server_group_name String AppServer组名称。 pre_conn_time String 预连接时间。 start_time String 会话开始时间。 end_time String 会话结束时间。 status_continue_time String 状态持续时间。 machine_sid String 服务器SID。 machine_name String 服务器名称。 session_state String 会话状态。 app_name String 会话中的应用名称。 client_mac String 客户端Mac地址。 client_name String 客户端名称。 client_ip String 客户端IP。 public_ip String 客户端出口ip。 client_version String 客户端版本。 client_type String 客户端类型。 agent_version String agent版本。 vm_ip String 服务器IP。 failed_reason String 错误原因消息。 failed_code String 错误原因码。 last_update_status_time String 状态最后变化时间。 tenant_id String 租户ID。 primary_server_group_id String 主服务器组ID。 secondary_server_group_id String 备服务器组ID。 状态码： 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 错误描述。

URI GET /v1/{project_id}/session/list-sessions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单次查询的大小[1-100]。 offset 否 Integer 查询的偏移量。 user_name 否 String 用户名。 query_begin_time 是 String 搜索开始时间，以会话开始时间为条件查询，格式2024-02-27T03:47:51.182Z。 query_end_time 是 String 搜索结束时间，以会话开始时间为条件查询，格式2024-02-27T03:47:51.182Z。 app_server_group_id 否 String AppServer组ID。 vm_ip 否 String 服务器IP。 public_ip 否 String 客户端出口IP。 machine_name 否 String 应用服务器名称。 session_state 否 String 应用状态，支持查询多个，中间用英文逗号分隔： Active - 会话当前处于活动状态，有用户登录并且正在使用。 Disconnected - 用户已经登录但会话处于断开连接状态。 AppcInit - 会话正在初始化。 SignedOut - 会话已注销。 InitFail - 会话初始化失败。 is_success 否 String 会话是否创建成功,默认不填则查询全部 'true' - 会话创建成功 'false' - 会话创建失败

响应示例 状态码： 200 正常。 { "policies" : [ { "policy_id" : "8ac225c2781edb0d01781edde3f4xxxx", "create_time" : "2022-10-24T17:24:56.000+00:00", "policy_name" : "PRIVATE_ACCESS", "blacklist_type" : "INTERNET" } ], "total" : 1 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 policies Array of AccessPolicyDetailInfo objects 查询接入策略响应。 total Integer 策略总数。 表5 AccessPolicyDetailInfo 参数 参数类型 描述 policy_name String 策略名。 blacklist_type String 黑名单类型，当前黑名单只支持互联网。 INTERNET： 互联网 access_control_type String 访问控制类型。默认为接入类型 ACCESS_TYPE： 接入类型 IP_WHITE_LIST： IP白名单 ip_list Array of IpInfo objects 策略的ip列表。 ip_total_count Integer 策略总数。 policy_id String 策略id。 create_time String 接入策略创建的时间。 表6 IpInfo 参数 参数类型 描述 ip_address String ip地址。 subnet_mask String 子网掩码。 状态码： 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接口进行解密。 状态码： 405 表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接口进行解密。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/access-policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 access_control_type 否 String 接入策略控制类型 ACCESS_TYPE： 接入类型 IP_WHITE_LIST： IP白名单 limit 否 Integer 每页数量,范围0-100,默认100。 offset 否 Integer 偏移量,范围0-99,默认0。

响应示例 状态码： 200 正常。 { "id" : "2c2be3fb-0013-48d5-a081-0731f3473997", "name" : "POOL2", "type" : "DYNAMIC", "description" : "string。", "created_time" : "2023-01-04T07:10:53.554Z", "charging_mode" : "1", "desktop_count" : 10, "desktop_used" : 5, "on_demand_desktop_num" : 0, "availability_zone" : "string", "subnet_id" : "string", "product" : { "product_id" : "workspace.x86.ultimate.large2", "flavor_id" : "s6.large.2", "type" : "BASE", "cpu" : "2", "memory" : "4096", "descriptions" : "尊享办公|2核|4GB内存。", "charge_mode" : "1", "architecture" : "x86", "is_gpu" : false, "package_type" : "ultimate", "system_disk_type" : "SAS", "system_disk_size" : "80", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.desktop", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "status" : "normal", "sub_product_list" : [ ] }, "image_id" : "string", "image_name" : "string", "image_os_type" : "string", "image_os_version" : "string", "image_os_platform" : "string", "image_product_code" : "string", "root_volume" : { "id" : "string", "type" : "string", "size" : 8200, "cluster_id" : "string", "resource_spec_code" : "string" }, "data_volumes" : [ { "id" : "string", "type" : "string", "size" : 8200, "cluster_id" : "string", "resource_spec_code" : "string" } ], "security_groups" : [ { "id" : "string", "name" : "string" } ], "disconnected_retention_period" : 10, "enable_autoscale" : true, "autoscale_policy" : { "autoscale_type" : "AUTO_CREATED", "max_auto_created" : 1000, "min_idle" : 100, "once_auto_created" : 10 }, "status" : "STEADY", "enterprise_project_id" : "0", "in_maintenance_mode" : false, "desktop_name_policy_id" : "TEST" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 桌面池ID。 name String 桌面池名称。 type String 桌面池类型。DYNAMIC：动态池，STATIC：静态池。 description String 桌面池描述。 created_time String 创建时间，格式为：UTC格式，例如“2022-05-11T11:45:42.000Z”。 charging_mode String 计费模式，0：包周期，1：按需。 desktop_count Integer 桌面池总桌面数量。 desktop_used Integer 桌面池绑定用户的桌面个数。 availability_zone String 可用区。 subnet_id String 子网ID。 product ProductInfo object 产品信息。 image_id String 镜像ID。 image_name String 镜像名称。 image_os_type String 镜像OS类型。 image_os_version String 镜像OS版本。 image_os_platform String 镜像OS平台。 image_product_code String 镜像的productCode（specCode）。 root_volume VolumeInfo object 系统盘。 data_volumes Array of VolumeInfo objects 数据盘列表。 security_groups Array of SecurityGroup objects 桌面安全组。 disconnected_retention_period Integer 动态池桌面断连多少分钟内，保留用户与桌面的绑定关系，超时后自动解绑。 enable_autoscale Boolean 桌面池是否开启弹性伸缩类型，为false则表示不开启弹性伸缩，为true则表示开启弹性伸缩。 autoscale_policy AutoscalePolicy object 弹性伸缩策略。 status String 桌面池状态。 STEADY：稳态 TEMPORARY：临时态 EXIST_FROZEN：存在冻结桌面 UNKNOWN：未知态 enterprise_project_id String 企业项目ID。 in_maintenance_mode Boolean 桌面池是否处于管理员维护模式。 desktop_name_policy_id String 策略id，用于指定生成桌面名称策略。 表4 ProductInfo 参数 参数类型 描述 product_id String 产品ID。 flavor_id String 产品规格ID。 type String 产品类型。 BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 cpu String CPU。 memory String 内存。 descriptions String 产品描述。 charge_mode String 周期套餐标识，0表示包周期，1表示按需。 表5 VolumeInfo 参数 参数类型 描述 id String 批量操作磁盘的磁盘集合id。 type String 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 SAS：高IO。 SSD：超高IO。 size Integer 磁盘容量，单位GB。 resource_spec_code String 规格。 表6 SecurityGroup 参数 参数类型 描述 id String 安全组ID。 表7 AutoscalePolicy 参数 参数类型 描述 autoscale_type String 弹性伸缩类型，ACCESS_CREATED：接入时创建，AUTO_CREATED：弹性伸缩。 max_auto_created Integer 自动创建桌面上限。 min_idle Integer 空闲桌面低于多少时开始自动创建桌面。 once_auto_created Integer 一次自动创建桌面的数量。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表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接口进行解密。

请求示例 PUT /v2/29dfe82ada564ac2b927e1ff036d9a9b/policy-groups/1d23e82ada564ac2b927e1ff0361fe23 { "policy_group" : { "policy_group_name" : "string", "description" : "string。", "scope_flag" : 1, "priority" : 65535, "targets" : [ { "target_id" : "string", "target_name" : "string", "target_type" : "string" } ], "policies" : { "peripherals" : { "usb_custom_policy_debug" : "string", "usb_port_redirection" : { "usb_enable" : true, "options" : { "usb_image_enable" : true, "usb_video_enable" : true, "usb_printer_enable" : true, "usb_storage_enable" : false, "wireless_devices_enable" : false, "network_devices_enable" : false, "usb_smart_card_enable" : true, "other_usb_devices_enable" : false, "usb_redirection_customization_policy" : "string", "usb_redirection_mode" : "Common mode" } }, "device_redirection" : { "printer_redirection" : { "printer_enable" : true, "options" : { "mobile_printer_enable" : false, "print_data_compression_mode" : false, "sync_client_default_printer_enable" : true, "universal_printer_driver" : "Default" } }, "session_printer" : { "session_printer_enable" : false, "options" : { "session_printer_customization_policy" : "string" } }, "camera_redirection" : { "video_compress_enable" : true, "options" : { "camera_frame_rate" : 15, "camera_max_width" : 3000, "camera_max_heigth" : 3000, "camera_compression_method" : "H.264" } }, "twain_redirection_enable" : true, "image_compression_level" : "medium", "hid_redirection" : { "hid_redirection_enable" : false, "options" : { "hid_redirection_customization_policy" : "string" } } }, "usb_device_common" : { "pcsc_smart_card_enable" : "Disable", "common_options" : { "remove_smart_card_disconnect_enable" : false } }, "serial_port_redirection" : { "serial_port_enable" : false, "options" : { "auto_connect_enable" : false } }, "parallel_port_redirection" : { "parallel_port_enable" : false }, "driver_interface_redirection" : { "api_redir_driver_list" : "string" } }, "audio" : { "audio_redirection_enable" : true, "play_volume" : "Do Not Set Volume", "play_volume_ratio" : "Do Not Set Volume Ratio", "record_volume" : "100", "record_volume_ratio" : "Do Not Set Volume Ratio", "audio_transmission_mode" : "Reliable Transmission", "play_redirection_enable" : true, "play_classification" : "Music Play", "play_quality" : "Middle", "play_denoising" : "Disable Denoising", "play_agc" : "Disable AGC", "play_crc" : "Disable CRC", "play_device_mode" : "Play Device In Shared Mode", "play_delay_threshold" : "240", "play_amplitude_threshold" : "4096", "play_prefill_data" : "Do Not Prefill Data", "record_redirection_enable" : true, "record_classification" : "Speech Call", "record_quality" : "Middle", "record_denoising" : "-25", "record_agc" : "Disable AGC", "record_crc" : "Disable CRC", "record_device_mode" : "Record Device In Shared Mode", "record_delay_threshold" : "200", "record_amplitude_threshold" : "4096" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180, "autoclose_monitor_after_locked" : false, "autoclose_monitor_options" : { "autoclose_monitor_wait_time" : 300 }, "forbid_screen_capture" : false, "client_machine_join_domain" : true, "client_type" : { "client_type_limit" : true, "options" : { "sc_type_window" : true, "sc_type_mac" : true, "sc_type_android" : true, "sc_type_linux" : true, "sc_type_h5" : true, "sc_type_ios" : true, "sc_type_harmony_os" : true, "tc_type_all" : true } } }, "display" : { "display_level" : "LEVEL4", "options" : { "display_bandwidth" : 20000, "frame_rate" : 25, "video_frame_rate" : 30, "min_image_cache" : 200, "smoothing_factor" : 60, "lossless_compression_mode" : "Basic Compression", "deep_compression_options" : { "deep_compression_level" : "Compression grade 0" }, "lossy_compression_quality" : 85, "color_enhancement_enable" : false, "quality_bandwidth_first" : "Quality First", "video_bit_rate_options" : { "average_video_bit_rate" : 18000 }, "peak_video_bit_rate" : 18000, "video_quality_options" : { "average_video_quality" : 15, "lowest_video_quality" : 25, "highest_video_quality" : 7 }, "gop_size" : 100, "encoding_preset" : "Preset 1" }, "rendering_acceleration_enable" : false, "rendering_acceleration_options" : { "video_acceleration_enhancement_enable" : true, "video_optimization_enable" : false, "gpu_color_optimization_enable" : false, "video_recognition_threshold" : 10, "frame_rate_statistical_length" : 4, "image_quality_threshold" : 0, "refresh_frequency_threshold" : 3, "exiting_video_area_threshold" : 8, "min_video_width" : 191, "min_video_length" : 191, "single_frame_natural_percentage" : "0.3", "cyclical_natural_images_number" : 2, "non_natural_image_percentage" : "0.85", "non_natural_images_number" : 25 }, "adaptive_bitrate_control_enable" : false, "adaptive_bitrate_control_options" : { "peak_bandwidth_suppression_enable" : false, "expected_average_network_latency" : 160, "network_latency_threshold1" : 160, "network_latency_threshold2" : 300, "min_dynamic_frame_rate" : 17, "min_dynamic_frame_rate_lv1" : 17, "min_dynamic_frame_rate_lv2" : 10, "rtt_threshold" : 20, "min_add_framerate" : 8, "max_add_framerate" : 20, "sub_framerate" : 25, "adaptive_bandwidth_lower_limit" : 500, "adaptive_compression_quality_lower_limit" : 60, "adaptive_compression_quality_upper_limit" : 85, "adaptive_compression_quality_increase_limit" : 5, "adaptive_compression_quality_decrease_limit" : 10, "adaptive_average_quality_lower_limit" : 15, "adaptive_average_quality_upper_limit" : 25, "adaptive_average_quality_increase_limit" : 3, "adaptive_average_quality_decrease_limit" : 1, "adaptive_min_quality_lower_limit" : 25, "adaptive_min_quality_upper_limit" : 30, "adaptive_min_quality_increase_limit" : 3, "adaptive_min_quality_decrease_limit" : 1 }, "video_card_memory_size" : 64, "configuration1_enable" : false, "driver_delegation_mode_enable" : false, "driver_delegation_latency" : 80, "video_latency" : 80, "change_resolution_vm" : false, "application_recognition" : "string", "duplicate_display_enable" : false, "default_mapping_order" : "1,2,3,4", "duplicate_display_mode" : "One-to-One" }, "file_and_clipboard" : { "file_redirection" : { "redirection_mode" : "DISABLED", "options" : { "fluid_control_switch_enable" : false, "fluid_control_options" : { "good_network_latency" : 30, "normal_network_latency" : 70, "poor_network_latency" : 100, "reducing_step" : 20, "slow_increasing_step" : 10, "quick_increasing_step" : 20, "start_speed" : 1024, "test_block_size" : 64, "test_time_gap" : 10000 }, "compression_switch_enable" : false, "compression_switch_options" : { "compression_threshold" : 512, "minimum_compression_rate" : 900 }, "linux_file_size_supported_enable" : true, "linux_file_size_supported_options" : { "linux_file_size_supported_threshold" : 100 }, "linux_root_mount_switch_enable" : true, "linux_root_dir_list" : "\\\\var\\\\log", "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media", "linux_fixed_drive_file_system_format" : "string", "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir|lifs", "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf", "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs", "path_separator" : "|", "fixed_drive_enable" : true, "removable_drive_enable" : true, "cd_rom_drive_enable" : true, "network_drive_enable" : true }, "vm_send_file_client" : true, "redirection_send_file_options" : { "read_write_speed" : 0 } }, "clip_length_limit_flag_c2s" : true, "clip_length_limit_c2s" : 180, "clip_length_limit_flag_s2c" : true, "clip_length_limit_s2c" : 180, "fd_mobile_client_redir_enable" : true, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "clipboard_file_redirection_enable" : true } }, "access_control" : { "ip_access_control" : "string" }, "session" : { "vdi" : { "auto_lock_enable" : true, "auto_lock_options" : { "auto_lock_minutes" : 10, "auto_disconnect" : "DISABLED", "options" : { "auto_disconnect_minutes" : 1440 } }, "disconnect_logout_enable" : 0, "disconnect_logout_options" : { "disconnect_logout_minutes" : 10 }, "disconnect_hibernate_enable" : false, "disconnect_hibernate_options" : { "disconnect_hibernate_minutes" : 0 }, "no_operation_hibernate_enable" : false, "no_operation_hibernate_options" : { "no_operation_hibernate_minutes" : 0 } }, "self_help_console" : true, "disconnect_on_lock_flag" : false }, "bandwidth" : { "intelligent_data_transport_flag" : "DISABLE", "total_bandwidth_control_enable" : false, "options" : { "total_bandwidth_control_value" : 30000, "display_bandwidth_percentage_enable" : false, "display_bandwidth_percentage_options" : { "display_bandwidth_percentage_value" : 65 }, "multimedia_bandwidth_percentage_enable" : false, "multimedia_bandwidth_percentage_options" : { "multimedia_bandwidth_percentage_value" : 50 }, "usb_bandwidth_percentage_enable" : false, "usb_bandwidth_percentage_options" : { "usb_bandwidth_percentage_value" : 100 }, "pcsc_bandwidth_percentage_enable" : false, "pcsc_bandwidth_percentage_options" : { "pcsc_bandwidth_percentage_value" : 5 }, "twain_bandwidth_percentage_enable" : false, "twain_bandwidth_percentage_options" : { "twain_bandwidth_percentage_value" : 15 }, "printer_bandwidth_percentage_enable" : false, "printer_bandwidth_percentage_options" : { "printer_bandwidth_percentage_value" : 5 }, "com_bandwidth_percentage_enable" : false, "com_bandwidth_percentage_options" : { "com_bandwidth_percentage_value" : 3 }, "file_redirection_bandwidth_percentage_enable" : false, "file_redirection_bandwidth_percentage_options" : { "file_redirection_bandwidth_percentage_value" : 30 }, "clipboard_bandwidth_percentage_enable" : false, "clipboard_bandwidth_percentage_options" : { "clipboard_bandwidth_percentage_value" : 3 }, "secure_channel_bandwidth_percentage_enable" : false, "secure_channel_bandwidth_percentage_options" : { "secure_channel_bandwidth_percentage_value" : 30 }, "camera_bandwidth_percentage_enable" : false, "camera_bandwidth_percentage_options" : { "camera_bandwidth_percentage_value" : 30 }, "virtual_channel_bandwidth_percentage_enable" : false, "virtual_channel_bandwidth_percentage_options" : { "virtual_channel_bandwidth_percentage_value" : 65 } }, "display_bandwidth_control_enable" : false, "display_bandwidth_control_options" : { "display_bandwidth_control_value" : 20000 }, "multimedia_bandwidth_control_enable" : false, "multimedia_bandwidth_control_options" : { "multimedia_bandwidth_control_value" : 15000 }, "usb_bandwidth_control_enable" : false, "usb_bandwidth_control_options" : { "usb_bandwidth_control_value" : 30000 }, "pcsc_bandwidth_control_enable" : false, "pcsc_bandwidth_control_options" : { "pcsc_bandwidth_control_value" : 2000 }, "twain_bandwidth_control_enable" : false, "twain_bandwidth_control_options" : { "twain_bandwidth_control_value" : 5000 }, "printer_bandwidth_control_enable" : false, "printer_bandwidth_control_options" : { "printer_bandwidth_control_value" : 2000 }, "com_bandwidth_control_enable" : false, "com_bandwidth_control_options" : { "com_bandwidth_control_value" : 1000 }, "file_redirection_bandwidth_control_enable" : false, "file_redirection_bandwidth_control_options" : { "file_redirection_bandwidth_control_value" : 10000 }, "clipboard_bandwidth_control_enable" : false, "clipboard_bandwidth_control_options" : { "clipboard_bandwidth_control_value" : 1000 }, "secure_channel_bandwidth_control_enable" : false, "secure_channel_bandwidth_control_options" : { "secure_channel_bandwidth_control_value" : 10000 }, "camera_bandwidth_control_enable" : false, "camera_bandwidth_control_options" : { "camera_bandwidth_control_value" : 10000 }, "virtual_channel_bandwidth_control_enable" : false, "virtual_channel_bandwidth_control_options" : { "virtual_channel_bandwidth_control_value" : 20000 } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "string", "virtual_channel_plugin_details" : "string", "third_party_plugin_name" : "string" } }, "watermark" : { "watermark_enable" : false, "options" : { "show_style" : "RANDOM", "color" : "2a2a2a", "font_size" : 30, "opacity_setting" : "12.5", "content_item_count" : 1, "display_format" : "{\"AlignMode\":\"left\",\"DateTimeFormat\":\"DT\",\"DateFormat\":\"yyyy-mm-dd\",\"TimeFormat\":\"hh:mm:ss\",\"RepeatCount\":2,\"RepeatInterval\":10,\"DisplayFormat\":{\"Content1\":\"CustomContent\",\"Interval1\":\"n\",\"Content2\":\"UserName\",\"Interval2\":\"4\",\"Content3\":\"DateTime\"}}", "lean" : -45, "content_customized" : "string", "content_color" : 522857002, "watermark_security_access" : false, "user_extend_info_switch" : false, "user_extend_info" : "string" } }, "keyboard_mouse" : { "mouse_feedback" : "SELFADAPTION", "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : false, "selfhelp_console_enable" : true, "client_mouse_send_interval" : 30, "windows_client_keyboard_mode" : "GLOBAL", "windows_client_mouse_mode" : "WINDOW", "linux_client_keyboard_mode" : "EVENT", "linux_client_mouse_mode" : "EVENT", "special_keyboard" : false, "joy_stick_flag" : false }, "seamless" : { "seamless_enable" : false, "options" : { "seamless_apply_path" : "string" } }, "personalizedDataMgmt" : { "personalized_data_mgmt_path" : "string", "user_data_roaming_enable" : false, "user_data_roaming_options" : { "profile_streaming_enable" : false, "roamed_files_local_path" : "string", "exclude_folders_path" : "string", "roaming_registry_method" : "string", "roaming_registry_path" : "string" }, "user_folder_redirection_enable" : false, "user_folder_redirection_options" : { "restore_local_directories_enable" : false, "appData_roaming_enale" : false, "redirec_desktop" : false, "redirec_start_menu" : false, "redirec_documents" : false, "redirec_pictures" : false, "redirec_music" : false, "redirec_videos" : false, "redirec_favorites" : false, "redirec_contacts" : false, "redirec_downloads" : false, "redirec_links" : false, "redirec_searches" : false, "redirec_saved_games" : false }, "logoff_delete_user_configuration" : false, "network_drive_mapping_enable" : false, "network_drive_mapping_options" : { "network_drive_mapping_path" : "string", "drive_letter" : "string" } }, "custom" : { "custom_configuration1_enable" : false, "options" : { "custom_configuration1_rule" : "string" } }, "record_audit" : { "enable" : true, "rules" : { "rule" : { "record_type" : "string", "interval_record_start_time" : "string", "interval_record_end_time" : "string", "op_type" : "string", "audio_record" : true, "fps" : 0, "duration" : 0, "resolution" : "string", "retention_duration" : 0 } } } } } }

响应参数 状态码： 200 表68 响应Body参数 参数 参数类型 描述 id String 被修改策略主键。 状态码： 400 表69 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表70 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表71 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表72 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 uri String 分发软件信息的URI。 状态码： 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 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 script_execution_tasks Array of ScriptExecutionTask objects 脚本执行任务列表。 total_count Integer 总数。 表5 ScriptExecutionTask 参数 参数类型 描述 id String 任务id。 desktop_pool_id String 桌面池id。 desktop_pool_name String 桌面池名称。 scripts Array of Script objects 脚本信息列表。 command_content String 执行的命令行。 command_type String 命令行类型。 POWERSHELL：WINDOWS系统使用。 BAT：WINDOWS系统使用。 SHELL：LINUX系统使用。 start_time String 任务开始时间，格式为：yyyy-MM-ddTHH:mm:ssZ。 end_time String 任务结束时间，格式为：yyyy-MM-ddTHH:mm:ssZ。 status String 任务状态，值含： FINISH：已完成。 FAILED：失败。 RUNNING：运行中。 INIT： 初始化。 success_num Integer 成功数量。 failed_num Integer 失败数量。 skip_num Integer 跳过数量。 表6 Script 参数 参数类型 描述 id String 脚本id。 name String 脚本名称。 状态码： 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接口进行解密。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 正常。 { "script_execution_tasks" : [ { "id" : "string", "desktop_pool_id" : "string", "desktop_pool_name" : "string", "scripts" : [ { "id" : "string", "name" : "string" } ], "command_content" : "string", "command_type" : "string", "start_time" : "string", "end_time" : "string", "status" : "string", "success_num" : 0, "failed_num" : 0, "skip_num" : 0 } ], "total_count" : 0 }