华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 image_id 是 String 镜像id，要求与服务器原有镜像id不相同。 image_type 是 String 镜像类型： gold - 云市场镜像 public - 公共镜像 private - 私有镜像 shared - 共享镜像 other - 其他 os_type 是 String 系统类型，当前仅支持Windows。 Linux - Windows - Other - image_product_id 否 String 镜像的产品id，当镜像是市场镜像时候，该字段必传。 update_access_agent 否 Boolean 是否自动升级hda版本。

响应参数 状态码： 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 错误描述。 状态码： 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 错误描述。

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

响应参数 状态码： 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" : "94b8e5c7-008f-40d7-b59a-084de3638286", "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-****myhuaweicloud.com:443" }, "create_time" : "2023-06-08T07:08:09.412Z", "user_claim_count" : 0, "share_claim_count" : 0 } ] }

URI GET /v1/{project_id}/persistent-storages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 否 String WKS存储ID。 name 否 String 查询名称，模糊匹配。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PersistentStorage objects 存储列表。 表5 PersistentStorage 参数 参数类型 描述 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 错误描述。

响应示例 状态码： 200 查询策略模板信息的响应。 { "count" : 2, "items" : [ { "id" : "572947120093396992", "name" : "test0001", "priority" : 0, "description" : "test0001", "create_time" : "2023-05-29T07:39:50.509Z", "update_time" : "2023-05-29T07:39:50.509Z" }, { "id" : "572944657261002752", "name" : "tsfasdfas", "priority" : 0, "description" : "", "create_time" : "2023-05-29T07:30:03.324Z", "update_time" : "2023-05-29T07:30:03.324Z" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of PolicyGroup objects 策略组列表，返回列表条目数量上限为分页的最大上限值。 表5 PolicyGroup 参数 参数类型 描述 id String 策略组的唯一标识。 name String 策略组名称。 priority Integer 优先级。 description String 服务器组描述。 targets Array of Target objects 应用对象列表。 policies Policies object 策略。 create_time String 策略组创建时间。 update_time String 策略组更新时间。 表6 Target 参数 参数类型 描述 target_id String 对象ID。 target_name String 对象名称。 target_type String 对象类型。 USER：表示用户。 target_id：为用户ID。 target_name：为用户name。 USERGROUP：表示用户组。 target_id：为用户组ID。 target_name：为用户组name。 APPGROUP：应用组。 target_id：应用组id。 target_name：应用组名称。 OU：组织单元。 target_id：OUID。 target_name：OU名称。 ALL：表示所有。 target_id：default-apply-all-targets。 target_name：All-Targets。 表7 Policies 参数 参数类型 描述 peripherals peripherals object 外设。 audio audio object 音频。 client client object 客户端。 display display object 显示。 file_and_clipboard file_and_clipboard object 文件和剪切板。 session Session object 会话 virtual_channel VirtualChannel object 虚拟通道 keyboard_mouse keyboard_mouse object 键盘鼠标。 bandwidth Bandwidth object 带宽。 custom custom object 自定义策略 表8 peripherals 参数 参数类型 描述 usb_port_redirection usb_port_redirection object USB端口重定向。 device_redirection device_redirection object 设备重定向。 usb_device_common usb_device_common object USB和设备智能卡控制选项。 serial_port_redirection serial_port_redirection object 串口重定向。 表9 usb_port_redirection 参数 参数类型 描述 usb_enable Boolean 是否开启USB端口重定向。取值为： false：表示关闭。 true：表示开启。 options UsbPortRedirectionOptions object USB端口重定向控制的选项。 表10 UsbPortRedirectionOptions 参数 参数类型 描述 usb_image_enable Boolean 是否开启图像设备（如: 扫描仪）。取值为： false：表示关闭。 true：表示开启。 usb_video_enable Boolean 是否开启视频设备（如: 摄像头）。取值为： false：表示关闭。 true：表示开启。 usb_printer_enable Boolean 是否开启打印设备（如: 打印机）。取值为： false：表示关闭。 true：表示开启。 usb_storage_enable Boolean 是否开启存储设备（如: U盘）。取值为： false：表示关闭。 true：表示开启。 wireless_devices_enable Boolean 是否开启无线设备（如：蓝牙）。取值为： false：表示关闭。 true：表示开启。 network_devices_enable Boolean 是否开启网络设备（如：无线网卡）。取值为： false：表示关闭。 true：表示开启。 usb_smart_card_enable Boolean 是否开启智能卡设备（如：Ukey）。取值为： false：表示关闭。 true：表示开启。 other_usb_devices_enable Boolean 是否开启其他USB设备重定向。取值为： false：表示关闭。 true：表示开启。 usb_redirection_customization_policy String USB端口重定向自定义策略。 usb_redirection_mode String USB 重定向模式。取值为： Classical mode：经典模式。 Common mode：通用模式。 表11 device_redirection 参数 参数类型 描述 printer_redirection printer_redirection object 打印机重定向。 session_printer session_printer object 会话打印机。 camera_redirection camera_redirection object 摄像头重定向。 twain_redirection_enable Boolean 是否开启TWAIN设备重定向。取值为： false：表示关闭。 true：表示开启。 image_compression_level String 图形压缩级别。取值为： 不压缩：none。 低（速度最快）：low。 中（速度适中）：medium。 高（速度最慢）：high。 无损（无损压缩）：lossless。 低损（低损压缩）：low-loss。 中损（中损压缩）：medium-loss。 高损（高损压缩）：high-loss。 表12 printer_redirection 参数 参数类型 描述 printer_enable Boolean 是否开启打印机设备重定向。取值为： false：表示关闭。 true：表示开启。 options PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表13 PrinterRedirectionOptions 参数 参数类型 描述 sync_client_default_printer_enable Boolean 是否开启同步客户端默认打印机。取值为： false：表示关闭。 true：表示开启。 universal_printer_driver String 通用打印机驱动。取值为：- Default：linux客户端选择Universal Printing- PS，windows客户端选择HDP XPSDrv Driver。- HDP XPSDrv Driver。- Universal Printing PCL 5。- Universal Printing PCL 6。- Universal Printing PS。 表14 session_printer 参数 参数类型 描述 session_printer_enable Boolean 是否开启会话打印机。取值为： false：表示关闭。 true：表示开启。 options SessionPrinterOptions object 会话打印机控制选项。 表15 SessionPrinterOptions 参数 参数类型 描述 session_printer_customization_policy String 会话打印机自定义策略。 表16 camera_redirection 参数 参数类型 描述 video_compress_enable Boolean 是否开启摄像头设备重定向。取值为： false：表示关闭。 true：表示开启。 options CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表17 CameraRedirectionOptions 参数 参数类型 描述 camera_frame_rate Integer 摄像头帧率（fps）。取值范围为[1-30]。默认：15。 camera_max_width Integer 摄像头最大宽度（pixel）。取值范围为[1-9999]。默认：3000。 camera_max_heigth Integer 摄像头最大高度（pixel）。取值范围为[1-9999]。默认：3000。 camera_compression_method String 摄像头数据压缩方式。取值为：H.264。 表18 usb_device_common 参数 参数类型 描述 pcsc_smart_card_enable String 是否开启PC/SC智能卡重定向。取值为： Enable：表示已启动。 Closed：表示已关闭。 Disable：表示已禁用。 common_options common_options object USB和设备智能卡共同控制的选项。 表19 common_options 参数 参数类型 描述 remove_smart_card_disconnect_enable Boolean 是否移除智能卡断开用户会话。取值为： false：表示关闭。 true：表示开启。 表20 serial_port_redirection 参数 参数类型 描述 serial_port_enable Boolean 是否开启串口重定向。取值为： false：表示关闭。 true：表示开启。 options SerialPortRedirectionOptions object 串口重定向控制的选项。 表21 SerialPortRedirectionOptions 参数 参数类型 描述 auto_connect_enable Boolean 是否自动连接客户端串口。取值为： false：表示关闭。 true：表示开启。 表22 audio 参数 参数类型 描述 audio_redirection_enable Boolean 是否开启音频重定向。取值为： false：表示关闭。 true：表示开启。 play_redirection_enable Boolean 是否开启播音重定向。取值为： false：表示关闭。 true：表示开启。 play_classification String 播音场景。取值为： 无损播音：LossLess。 语音通话：Speech Call。 音乐播音：Music Play。 自动识别：Automatic Identification。 record_redirection_enable Boolean 是否开启录音重定向。取值为： false：表示关闭。 true：表示开启。 record_classification String 录音场景。取值为： 无损录音：LossLess。 语音通话：Speech Call。 音乐录音：Music Record。 自动识别：Automatic Identification。 表23 client 参数 参数类型 描述 automatic_reconnection_interval Integer 自动重连间隔（秒）。取值范围为[1-50]。默认：5。 session_persistence_time Integer 自动重连会话保持时长（秒）。取值范围为[0-180]。默认：180。 forbid_screen_capture Boolean 防截屏策略开关。 false：表示关闭。 true：表示开启。 表24 display 参数 参数类型 描述 display_level String 显示级别。取值为： LEVEL1：表示等级1。 LEVEL2：表示等级2。 LEVEL3：表示等级3。 LEVEL4：表示等级4（默认/推荐）。 LEVEL5：表示等级5。 options DisplayOptions object 显示级别共同控制的选项。 rendering_acceleration_enable Boolean 是否开启渲染加速。取值为： false：表示关闭。 true：表示开启。 rendering_acceleration_options rendering_acceleration_options object 渲染加速控制选项。 video_card_memory_size Integer 显卡缓存（MB）。取值范围为[0-64]。默认：64。 driver_delegation_mode_enable Boolean 是否开启驱动托管模式。取值为： false：表示关闭。 true：表示开启。 driver_delegation_latency Integer 驱动托管延时（*30ms）。取值范围为[1-100]。默认：80。 video_latency Integer 驱动托管视频延时（*30ms）。取值范围为[1-100]。默认：80。 change_resolution_vm Boolean 计算机修改分辨率：取值为： false：表示关闭。 true：表示开启。 表25 DisplayOptions 参数 参数类型 描述 display_bandwidth Integer 带宽（Kbps）。取值范围为[256-25000]。默认：20000。 frame_rate Integer 帧率（fps）。取值范围为[1-60]。默认：25。 video_frame_rate Integer 视频帧率（fps）。取值范围为[1-60]。默认：30。 min_image_cache Integer 图像缓存最低容量（MB）。取值范围[0-300]，默认：200。 smoothing_factor Integer 有损压缩识别阈值。取值范围为[0-255]。默认：60。 lossless_compression_mode String 无损压缩模式。取值为： Basic Compression：表示初级压缩。 Deep Compression：表示深度压缩。 deep_compression_options deep_compression_options object 深度压缩控制选项。 lossy_compression_quality Integer 有损压缩质量。取值范围为[20-100]。默认：85。 color_enhancement_enable Boolean 办公场景色彩增强：取值为： false：表示关闭。 true：表示开启。 quality_bandwidth_first String 质量或带宽优先。取值为： Quality First：表示初级压缩。 Bandwidth First：表示深度压缩。 video_bit_rate_options video_bit_rate_options object 视频码率控制选项。 peak_video_bit_rate Integer 视频峰值码率（Kbps）。取值范围为[256-100000]。默认：18000。 video_quality_options video_quality_options object 视频质量控制选项。 gop_size Integer GOP大小。取值范围为[0-65535]。默认：100。 encoding_preset String 编码预置。取值为： 预置1：Preset 1。 预置2：Preset 2。 预置3：Preset 3。 预置4：Preset 4。 预置5：Preset 5。 预置6：Preset 6。 预置7：Preset 7。 表26 deep_compression_options 参数 参数类型 描述 deep_compression_level String 深度压缩级别。取值为： 压缩级别0：Compression grade 0 压缩级别1：Compression grade 1 压缩级别2：Compression grade 2 压缩级别3：Compression grade 3 压缩级别4：Compression grade 4 压缩级别5：Compression grade 5 压缩级别6：Compression grade 6 压缩级别7：Compression grade 7 压缩级别8：Compression grade 8 压缩级别9：Compression grade 9 表27 video_bit_rate_options 参数 参数类型 描述 average_video_bit_rate Integer 视频平均码率（Kbps）。取值范围为[256-100000]。默认：18000。 表28 video_quality_options 参数 参数类型 描述 average_video_quality Integer 视频平均质量。取值范围为[5-59]。默认：15。 lowest_video_quality Integer 视频最低质量。取值范围为[5-69]。默认：25。 highest_video_quality Integer 视频最高质量。取值范围为[1-59]。默认：7。 表29 rendering_acceleration_options 参数 参数类型 描述 video_acceleration_enhancement_enable Boolean 视频加速增强配置。取值为： false：表示关闭。 true：表示开启。 video_optimization_enable Boolean 是否开启视频场景优化。取值为： false：表示关闭。 true：表示开启。 gpu_color_optimization_enable Boolean 是否开启GPU色彩优化。取值为： false：表示关闭。 true：表示开启。 表30 file_and_clipboard 参数 参数类型 描述 bypass_in_remote_app_enable Boolean 应用聚合场景下是否双向放通：取值为： false：表示不放通。 true：表示放通。 file_redirection file_redirection object 文件重定向。 fd_mobile_client_redir_enable Boolean 移动客户端文件重定向：取值为： false：表示关闭。 true：表示开启。 clipboard_redirection String 剪切板重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_redirection_options clipboard_redirection_options object 剪切板重定向控制的选项。 表31 file_redirection 参数 参数类型 描述 redirection_mode String 文件重定向。取值为： DISABLED：表示禁用。（默认） READ_ONLY：表示只读。 READ_AND_WRITE：表示读写。 options FileRedirectionOptions object 文件重定向控制的选项。 vm_send_file_client Boolean 是否开启发送文件（虚机到客户端）。取值为： false：表示关闭。 true：表示开启。 redirection_send_file_options redirection_send_file_options object 重定向和发送文件共同控制项。 表32 FileRedirectionOptions 参数 参数类型 描述 fluid_control_switch_enable Boolean 是否开启流控开关。取值为： false：表示关闭。 true：表示开启。 fluid_control_options fluid_control_options object 流控控制项。 compression_switch_enable Boolean 是否开启压缩开关。取值为： false：表示关闭。 true：表示开启。 compression_switch_options compression_switch_options object 压缩开关控制项。 linux_file_size_supported_enable Boolean 是否开启Linux支持设置文件大小。取值为： false：表示关闭。 true：表示开启。 linux_file_size_supported_options linux_file_size_supported_options object Linux支持设置文件大小控制项。 linux_root_mount_switch_enable Boolean 是否开启Linux根目录挂载开关。取值为： false：表示关闭。 true：表示开启。 linux_root_dir_list String Linux根目录挂载路径。默认："\home"。 linux_file_mount_path String Linux文件系统挂载路径。默认："\media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media"。 linux_fixed_drive_file_system_format String Linux固定驱动器文件系统格式。 linux_removable_drive_file_system_format String Linux可移动驱动器文件系统格式。默认："vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir"。 linux_cdrom_drive_file_system_format String Linux光盘驱动器文件系统格式。默认："cd9660|iso9660|udf"。 linux_network_drive_file_system_format String Linux网络驱动器文件系统格式。默认："smbfs|afpfs|cifs"。 path_separator String 路径分隔符。默认："|"。 fixed_drive_enable Boolean 是否开启固定驱动器（如: 本地磁盘）。取值为： false：表示关闭。 true：表示开启。 removable_drive_enable Boolean 是否开启可移除驱动器（如: U盘）。取值为： false：表示关闭。 true：表示开启。 cd_rom_drive_enable Boolean 是否开启光盘驱动器。取值为： false：表示关闭。 true：表示开启。 network_drive_enable Boolean 是否开启网络驱动器。取值为： false：表示关闭。 true：表示开启。 表33 fluid_control_options 参数 参数类型 描述 good_network_latency Integer 网络优的延时阈值（ms）。取值范围为[1-1000]。默认：30。 normal_network_latency Integer 网络一般的延时阈值（ms）。取值范围为[1-1000]。默认：70。 poor_network_latency Integer 网络差的延时阈值（ms）。取值范围为[1-1000]。默认：100。 reducing_step Integer 降速步伐（KB）。取值范围为[1-100]。默认：20。 slow_increasing_step Integer 慢增速步伐（KB）。取值范围为[1-100]。默认：10。 quick_increasing_step Integer 快增速步伐（KB）。取值范围为[1-100]。默认：20。 start_speed Integer 传输初始速度（KB/s）。取值范围为[1-10240]。默认：1024。 test_block_size Integer 测速块大小（KB）。取值范围为[64-1024]。默认：64。 test_time_gap Integer 测速块时间间隔（ms）。取值范围为[1000-100000]。默认：10000。 表34 compression_switch_options 参数 参数类型 描述 compression_threshold Integer 压缩阈值（Byte）。取值范围为[0-10240]。默认：512。 minimum_compression_rate Integer 最小压缩率。取值范围为[0-1000]。默认：900。 表35 linux_file_size_supported_options 参数 参数类型 描述 linux_file_size_supported_threshold Integer Linux设置文件大小阈值（Byte）。取值范围为[0-4096]。默认：100。 表36 redirection_send_file_options 参数 参数类型 描述 read_write_speed Integer 读写速度（Kbps）。取值范围为[0-2147483647]。默认：0。 表37 clipboard_redirection_options 参数 参数类型 描述 rich_text_redirection_enable Boolean 是否开启剪切板富文本重定向。取值为： false：表示关闭。 true：表示开启。 rich_text_clipboard_redirection String 剪切板富文本重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_file_redirection_enable Boolean 是否开启剪切板文件重定向。取值为： false：表示关闭。 true：表示开启。 file_clipboard_redirection String 剪切板文件重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_length_limit_cts_enable Boolean 本地到虚拟机长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_cts Integer 本地到虚拟机长度限制。 clipboard_length_limit_stc_enable Boolean 虚拟机到本地到长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_stc Integer 虚拟机到本地长度限制。 表38 Session 参数 参数类型 描述 sbc Sbc object SBC结构体。 表39 Sbc 参数 参数类型 描述 sbc_automatic_disconnection String 连接策略： DISABLED：已禁用 AUTO_DISCONNECT：自动断开 AUTO_LOCK：自动锁屏 sbc_automatic_disconnection_options SbcAutomaticDisconnectionOptions object 自动连接选项。 表40 SbcAutomaticDisconnectionOptions 参数 参数类型 描述 disconnection_waiting_time Integer 等待时间（分钟）。 sbc_auto_logout Boolean 是否自动注销。取值为：false：表示是。true：表示否。 auto_logout_options AutoLogoutOptions object 自动注销。 表41 AutoLogoutOptions 参数 参数类型 描述 sbc_logout_waiting_time Integer 会话断连保留时长（分钟）。 表42 VirtualChannel 参数 参数类型 描述 virtual_channel_control_enable Boolean 是否开启虚拟通道策略设置。取值为：false：表示关闭。true：表示开启。 options VirtualChannelOptions object 虚拟通道策略控制的选项。 表43 VirtualChannelOptions 参数 参数类型 描述 custom_virtual_channel_name String 自定义虚拟通道注册名。 virtual_channel_plugin_details String 虚拟通道下载配置信息，需Base64加密。 third_party_plugin_name String 第三方插件名称。 表44 keyboard_mouse 参数 参数类型 描述 mouse_feedback String 虚拟机鼠标回馈。取值为： SELFADAPTION：自适应鼠标回馈。 FORCE：强制鼠标回馈。 CLOSE：关闭鼠标回馈。 mouse_simulation_mode String 虚拟机鼠标模拟方式。取值为： ABSOLUTE_POSITION：绝对位置模拟。 RELATIVE_POSITION：相对位置模拟。 external_cursor_feedback Boolean 虚拟机外部光标反馈。取值为： false：表示关闭。 true：表示开启。 表45 Bandwidth 参数 参数类型 描述 intelligent_data_transport_flag String 智能显示传输。取值为：DISABLE：表示关闭。ENABLE：表示开启。DIAGNOSTIC：诊断模式。 total_bandwidth_control_enable Boolean 是否开启总带宽控制。取值为：false：表示关闭。true：表示开启。 options TotalBandwidthControlOptions object 总带宽控制的选项。 display_bandwidth_control_enable Boolean 是否开启显示带宽控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_control_options DisplayBandwidthControlOptions object 显示带宽控制的选项。 multimedia_bandwidth_control_enable Boolean 是否开启多媒体带宽控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_control_options MultimediaBandwidthControlOptions object 多媒体带宽控制的选项。 usb_bandwidth_control_enable Boolean 是否开启USB带宽控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_control_options UsbBandwidthControlOptions object USB带宽控制的选项。 pcsc_bandwidth_control_enable Boolean 是否开启P CS C控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_control_options PcscBandwidthControlOptions object PCSC带宽控制的选项。 twain_bandwidth_control_enable Boolean 是否开启TWAIN带宽控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_control_options TwainBandwidthControlOptions object TWAIN带宽控制的选项。 printer_bandwidth_control_enable Boolean 是否开启打印机带宽控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_control_options PrinterBandwidthControlOptions object 打印机带宽控制的选项。 com_bandwidth_control_enable Boolean 是否开启串口带宽控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_control_options ComBandwidthControlOptions object 串口带宽控制的选项。 file_redirection_bandwidth_control_enable Boolean 是否开启文件重定向带宽控制。取值为：false：表示关闭。true：表示开启 file_redirection_bandwidth_control_options FileRedirectionBandwidthControlOptions object 文件重定向带宽控制的选项。 clipboard_bandwidth_control_enable Boolean 是否开启剪切板带宽控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_control_options ClipboardBandwidthControlOptions object 剪切板带宽控制的选项。 secure_channel_bandwidth_control_enable Boolean 是否开启安全通道带宽控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_control_options SecureChannelBandwidthControlOptions object 安全通道带宽控制的选项。 camera_bandwidth_control_enable Boolean 是否开启摄像头带宽控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_control_options CameraBandwidthControlOptions object 摄像头带宽控制的选项。 virtual_channel_bandwidth_control_enable Boolean 是否开启虚拟通道带宽控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_control_options VirtualChannelBandwidthControlOptions object 虚拟通道带宽控制的选项。 表46 TotalBandwidthControlOptions 参数 参数类型 描述 total_bandwidth_control_value Integer 总带宽控制量（Kbps）。取值范围为[10000-1000000]。默认：30000。 display_bandwidth_percentage_enable Boolean 显示带宽百分比控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_percentage_options DisplayBandwidthPercentageOptions object 显示带宽百分比控制的选项。 multimedia_bandwidth_percentage_enable Boolean 多媒体带宽百分比控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_percentage_options MultimediaBandwidthPercentageOptions object 多媒体带宽百分比控制的选项。 usb_bandwidth_percentage_enable Boolean USB带宽百分比控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_percentage_options UsbBandwidthPercentageOptions object USB带宽百分比控制的选项。 pcsc_bandwidth_percentage_enable Boolean PCSC带宽百分比控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_percentage_options PcscBandwidthPercentageOptions object PCSC带宽百分比控制的选项。 twain_bandwidth_percentage_enable Boolean TWAIN带宽百分比控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_percentage_options TwainBandwidthPercentageOptions object TWAIN带宽百分比控制的选项。 printer_bandwidth_percentage_enable Boolean 打印机带宽百分比控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_percentage_options PrinterBandwidthPercentageOptions object 打印机带宽百分比控制的选项。 com_bandwidth_percentage_enable Boolean 串口带宽百分比控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_percentage_options ComBandwidthPercentageOptions object 串口带宽百分比控制的选项。 file_redirection_bandwidth_percentage_enable Boolean 文件重定向带宽百分比控制。取值为：false：表示关闭。true：表示开启。 file_redirection_bandwidth_percentage_options FileRedirectionBandwidthPercentageOptions object 文件重定向带宽百分比控制的选项。 clipboard_bandwidth_percentage_enable Boolean 剪切板带宽百分比控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_percentage_options ClipboardBandwidthPercentageOptions object 剪切板带宽百分比控制的选项。 secure_channel_bandwidth_percentage_enable Boolean 安全通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_percentage_options SecureChannelBandwidthPercentageOptions object 安全通道带宽百分比控制的选项。 camera_bandwidth_percentage_enable Boolean 摄像头带宽百分比控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_percentage_options CameraBandwidthPercentageOptions object 摄像头带宽百分比控制的选项。 virtual_channel_bandwidth_percentage_enable Boolean 虚拟通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_percentage_options VirtualChannelBandwidthPercentageOptions object 虚拟通道带宽百分比控制的选项。 表47 DisplayBandwidthPercentageOptions 参数 参数类型 描述 display_bandwidth_percentage_value Integer 显示带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表48 MultimediaBandwidthPercentageOptions 参数 参数类型 描述 multimedia_bandwidth_percentage_value Integer 多媒体带宽百分比控制量（%）。取值范围为[0-100]。默认：50。 表49 UsbBandwidthPercentageOptions 参数 参数类型 描述 usb_bandwidth_percentage_value Integer USB带宽百分比控制量（%）。取值范围为[0-100]。默认：100。 表50 PcscBandwidthPercentageOptions 参数 参数类型 描述 pcsc_bandwidth_percentage_value Integer PCSC带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表51 TwainBandwidthPercentageOptions 参数 参数类型 描述 twain_bandwidth_percentage_value Integer TWAIN带宽百分比控制量（%）。取值范围为[0-100]。默认：15。 表52 PrinterBandwidthPercentageOptions 参数 参数类型 描述 printer_bandwidth_percentage_value Integer 打印机带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表53 ComBandwidthPercentageOptions 参数 参数类型 描述 com_bandwidth_percentage_value Integer 串口带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表54 FileRedirectionBandwidthPercentageOptions 参数 参数类型 描述 file_redirection_bandwidth_percentage_value Integer 文件重定向带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表55 ClipboardBandwidthPercentageOptions 参数 参数类型 描述 clipboard_bandwidth_percentage_value Integer 剪切板带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表56 SecureChannelBandwidthPercentageOptions 参数 参数类型 描述 secure_channel_bandwidth_percentage_value Integer 安全通道带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表57 CameraBandwidthPercentageOptions 参数 参数类型 描述 camera_bandwidth_percentage_value Integer 摄像头带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表58 VirtualChannelBandwidthPercentageOptions 参数 参数类型 描述 virtual_channel_bandwidth_percentage_value Integer 虚拟通道带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表59 DisplayBandwidthControlOptions 参数 参数类型 描述 display_bandwidth_control_value Integer 显示带宽控制量（Kbps）。取值范围为[500-50000]。默认：20000。 表60 MultimediaBandwidthControlOptions 参数 参数类型 描述 multimedia_bandwidth_control_value Integer 多媒体带宽控制量（Kbps）。取值范围为[5000-20000]。默认：15000。 表61 UsbBandwidthControlOptions 参数 参数类型 描述 usb_bandwidth_control_value Integer USB带宽控制量（Kbps）。取值范围为[1000-30000]。默认：30000。 表62 PcscBandwidthControlOptions 参数 参数类型 描述 pcsc_bandwidth_control_value Integer PCSC带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表63 TwainBandwidthControlOptions 参数 参数类型 描述 twain_bandwidth_control_value Integer TWAIN带宽控制量（Kbps）。取值范围为[2000-10000]。默认：5000。 表64 PrinterBandwidthControlOptions 参数 参数类型 描述 printer_bandwidth_control_value Integer 打印机带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表65 ComBandwidthControlOptions 参数 参数类型 描述 com_bandwidth_control_value Integer 串口带宽控制量（Kbps）。取值范围为[500-2000]。默认：1000。 表66 FileRedirectionBandwidthControlOptions 参数 参数类型 描述 file_redirection_bandwidth_control_value Integer 文件重定向带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表67 ClipboardBandwidthControlOptions 参数 参数类型 描述 clipboard_bandwidth_control_value Integer 剪切板带宽控制量（Kbps）。取值范围为[100-2000]。默认：1000。 表68 SecureChannelBandwidthControlOptions 参数 参数类型 描述 secure_channel_bandwidth_control_value Integer 安全通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表69 CameraBandwidthControlOptions 参数 参数类型 描述 camera_bandwidth_control_value Integer 摄像头带宽控制量（Kbps）。取值范围为[0-10000]。默认：10000。 表70 VirtualChannelBandwidthControlOptions 参数 参数类型 描述 virtual_channel_bandwidth_control_value Integer 虚拟通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：20000。 表71 custom 参数 参数类型 描述 custom_configuration1_enable Boolean 自定义策略配置项1： false: 表示关闭 true: 表示开启 options CustomOptions object 自定义策略设置项。 表72 CustomOptions 参数 参数类型 描述 custom_configuration1_rule String 配置项1内容。 状态码： 400 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表77 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表78 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表79 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

URI GET /v1/{project_id}/policy-templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 policy_group_name 否 String 根据策略模板名字过滤结果。

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

响应示例 状态码： 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 成功响应。 { "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" } } ] }

响应参数 状态码： 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 错误描述。

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 objects 批量请求列表，一次请求数量区间 [1, 20]。 表4 items 参数 是否必选 参数类型 描述 id 是 String 服务器ID。 enable 是 Boolean **⚠ 预留字段，不使用，是否启用虚拟IP功能与服务器组配置保持一致。 是否启用虚拟IP功能。 开关只在租户配置允许启用虚拟IP场景有效，否则忽略传值并设置为关闭。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_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 错误描述。 状态码： 409 表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 错误描述。

请求示例 PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-servers/actions/batch-update-tsvi { "items" : [ { "id" : "3f791197-d166-4c8e-81e4-38c40ffc1989", "enable" : true }, { "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b", "enable" : true } ] }

响应示例 状态码： 200 成功响应。 { "count" : 1, "items" : [ { "id" : "573548db-9a6f-4b31-a5cb-d7aa40975466", "name" : "APS-20230509102837-IVTU6S27OY", "machine_name" : "APS-PR6KRMAL00", "description" : "", "server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "flavor" : { "id" : "s2.large.2", "links" : [ { "rel" : "self" }, { "rel" : "bookmark" } ] }, "status" : "REGISTERED", "create_time" : "2023-05-09T10:28:38.755Z", "update_time" : "2023-05-09T10:39:03.484Z", "image_id" : "ca8be629-112e-4865-b4fb-bbbca257f1d9", "availability_zone" : "cn-north-7a", "domain" : "wksapp***.huawei.com", "ou_name" : "", "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1399", "instance_id" : "4fa75b74-56bc-4a6b-b965-f2f139e17b5e", "os_version" : "Windows Server 2019 Datacenter 64bit", "os_type" : "Windows", "order_id" : "", "maintain_status" : false, "scaling_auto_create" : false, "resource_pool_id" : "10dd1a4f-ff85-4953-aa0f-2a37f28b6beb", "resource_pool_type" : "private", "server_group_name" : "Nas", "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" }, "metadata" : { "charging_mode" : "0", "metering.resourcespeccode" : "s2.large.2.win", "metering.resourcetype" : "1" }, "session_count" : 1, "vm_status" : "ACTIVE", "task_status" : "null", "freeze" : [ ], "host_address" : [ { "addr" : "192.*.*.145", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:75:06", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "257f2ff5-fe85-4b9a-86c2-5dacb64ac78f", "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "tenant_type" : "tenant" }, { "addr" : "10.*.*.79", "version" : 4, "OS-EXT-IPS-MAC:mac_addr" : "fa:16:**:**:02:88", "OS-EXT-IPS:type" : "FIXED", "OS-EXT-IPS:port_id" : "c6fc6fcc-c99e-4604-b0e0-04e48246c7cd", "vpc_id" : "82f75215-9ae6-4e69-882c-fe4088324839", "subnet_id" : "e851a83c-8696-48ea-b078-466fe9d361ae", "tenant_type" : "resource_tenant" } ] } ] }

URI GET /v1/{project_id}/app-servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 查询的数量，值区间[1-100]。 server_group_id 否 String 服务器组唯一标识。 server_name 否 String 服务器名称，支持部分匹配。 server_id 否 String 服务器唯一标识。 maintain_status 否 String 服务器维护状态： true : 维护态的实例。 false: 非维护态的实例。 scaling_auto_create 否 String 是否是弹性创建： true : 通过弹性伸缩创建。 false: 不是通过弹性伸缩创建。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 415 表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 成功响应。 { "count" : 1, "items" : [ { "storage_claim_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e", "folder_path" : "shares/video/", "delimiter" : "/", "claim_mode" : "SHARE", "count" : { "USER" : 0, "USER_GROUP" : 1 } } ] }

URI GET /v1/{project_id}/persistent-storages/actions/list-share-folders 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的偏移量。 limit 否 Integer 单次查询的大小[1-100]。 storage_id 是 String WKS存储ID。 storage_claim_id 否 String WKS存储目录声明ID。 path 否 String 查询名称需满足如下规则: 可见字符+空格。 长度0~128个字符。

响应参数 状态码： 200 表72 响应Body参数 参数 参数类型 描述 id String 被修改策略主键。 状态码： 400 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表77 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表78 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表79 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_group 是 PolicyGroupForUpdate object 修改的策略组详情。 表4 PolicyGroupForUpdate 参数 是否必选 参数类型 描述 policy_group_name 是 String 策略组名称，名称需要满足如下规则： 由英文、数字或者下划线组成，不能有空格。 字符长度范围1-55。 description 否 String 策略组描述。 priority 否 Integer 优先级。 targets 否 Array of Target objects 应用对象列表。 policies 否 Policies object 策略。 表5 Target 参数 是否必选 参数类型 描述 target_id 是 String 对象ID。 target_name 是 String 对象名称。 target_type 是 String 对象类型。 USER：表示用户。 target_id：为用户ID。 target_name：为用户name。 USERGROUP：表示用户组。 target_id：为用户组ID。 target_name：为用户组name。 APPGROUP：应用组。 target_id：应用组id。 target_name：应用组名称。 OU：组织单元。 target_id：OUID。 target_name：OU名称。 ALL：表示所有。 target_id：default-apply-all-targets。 target_name：All-Targets。 表6 Policies 参数 是否必选 参数类型 描述 peripherals 否 peripherals object 外设。 audio 否 audio object 音频。 client 否 client object 客户端。 display 否 display object 显示。 file_and_clipboard 否 file_and_clipboard object 文件和剪切板。 session 否 Session object 会话 virtual_channel 否 VirtualChannel object 虚拟通道 keyboard_mouse 否 keyboard_mouse object 键盘鼠标。 bandwidth 否 Bandwidth object 带宽。 custom 否 custom object 自定义策略 表7 peripherals 参数 是否必选 参数类型 描述 usb_port_redirection 否 usb_port_redirection object USB端口重定向。 device_redirection 否 device_redirection object 设备重定向。 usb_device_common 否 usb_device_common object USB和设备智能卡控制选项。 serial_port_redirection 否 serial_port_redirection object 串口重定向。 表8 usb_port_redirection 参数 是否必选 参数类型 描述 usb_enable 否 Boolean 是否开启USB端口重定向。取值为： false：表示关闭。 true：表示开启。 options 否 UsbPortRedirectionOptions object USB端口重定向控制的选项。 表9 UsbPortRedirectionOptions 参数 是否必选 参数类型 描述 usb_image_enable 否 Boolean 是否开启图像设备（如: 扫描仪）。取值为： false：表示关闭。 true：表示开启。 usb_video_enable 否 Boolean 是否开启视频设备（如: 摄像头）。取值为： false：表示关闭。 true：表示开启。 usb_printer_enable 否 Boolean 是否开启打印设备（如: 打印机）。取值为： false：表示关闭。 true：表示开启。 usb_storage_enable 否 Boolean 是否开启存储设备（如: U盘）。取值为： false：表示关闭。 true：表示开启。 wireless_devices_enable 否 Boolean 是否开启无线设备（如：蓝牙）。取值为： false：表示关闭。 true：表示开启。 network_devices_enable 否 Boolean 是否开启网络设备（如：无线网卡）。取值为： false：表示关闭。 true：表示开启。 usb_smart_card_enable 否 Boolean 是否开启智能卡设备（如：Ukey）。取值为： false：表示关闭。 true：表示开启。 other_usb_devices_enable 否 Boolean 是否开启其他USB设备重定向。取值为： false：表示关闭。 true：表示开启。 usb_redirection_customization_policy 否 String USB端口重定向自定义策略。 usb_redirection_mode 否 String USB 重定向模式。取值为： Classical mode：经典模式。 Common mode：通用模式。 表10 device_redirection 参数 是否必选 参数类型 描述 printer_redirection 否 printer_redirection object 打印机重定向。 session_printer 否 session_printer object 会话打印机。 camera_redirection 否 camera_redirection object 摄像头重定向。 twain_redirection_enable 否 Boolean 是否开启TWAIN设备重定向。取值为： false：表示关闭。 true：表示开启。 image_compression_level 否 String 图形压缩级别。取值为： 不压缩：none。 低（速度最快）：low。 中（速度适中）：medium。 高（速度最慢）：high。 无损（无损压缩）：lossless。 低损（低损压缩）：low-loss。 中损（中损压缩）：medium-loss。 高损（高损压缩）：high-loss。 表11 printer_redirection 参数 是否必选 参数类型 描述 printer_enable 否 Boolean 是否开启打印机设备重定向。取值为： false：表示关闭。 true：表示开启。 options 否 PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表12 PrinterRedirectionOptions 参数 是否必选 参数类型 描述 sync_client_default_printer_enable 否 Boolean 是否开启同步客户端默认打印机。取值为： false：表示关闭。 true：表示开启。 universal_printer_driver 否 String 通用打印机驱动。取值为：- Default：linux客户端选择Universal Printing- PS，windows客户端选择HDP XPSDrv Driver。- HDP XPSDrv Driver。- Universal Printing PCL 5。- Universal Printing PCL 6。- Universal Printing PS。 表13 session_printer 参数 是否必选 参数类型 描述 session_printer_enable 否 Boolean 是否开启会话打印机。取值为： false：表示关闭。 true：表示开启。 options 否 SessionPrinterOptions object 会话打印机控制选项。 表14 SessionPrinterOptions 参数 是否必选 参数类型 描述 session_printer_customization_policy 否 String 会话打印机自定义策略。 表15 camera_redirection 参数 是否必选 参数类型 描述 video_compress_enable 否 Boolean 是否开启摄像头设备重定向。取值为： false：表示关闭。 true：表示开启。 options 否 CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表16 CameraRedirectionOptions 参数 是否必选 参数类型 描述 camera_frame_rate 否 Integer 摄像头帧率（fps）。取值范围为[1-30]。默认：15。 camera_max_width 否 Integer 摄像头最大宽度（pixel）。取值范围为[1-9999]。默认：3000。 camera_max_heigth 否 Integer 摄像头最大高度（pixel）。取值范围为[1-9999]。默认：3000。 camera_compression_method 否 String 摄像头数据压缩方式。取值为：H.264。 表17 usb_device_common 参数 是否必选 参数类型 描述 pcsc_smart_card_enable 否 String 是否开启PC/SC智能卡重定向。取值为： Enable：表示已启动。 Closed：表示已关闭。 Disable：表示已禁用。 common_options 否 common_options object USB和设备智能卡共同控制的选项。 表18 common_options 参数 是否必选 参数类型 描述 remove_smart_card_disconnect_enable 否 Boolean 是否移除智能卡断开用户会话。取值为： false：表示关闭。 true：表示开启。 表19 serial_port_redirection 参数 是否必选 参数类型 描述 serial_port_enable 否 Boolean 是否开启串口重定向。取值为： false：表示关闭。 true：表示开启。 options 否 SerialPortRedirectionOptions object 串口重定向控制的选项。 表20 SerialPortRedirectionOptions 参数 是否必选 参数类型 描述 auto_connect_enable 否 Boolean 是否自动连接客户端串口。取值为： false：表示关闭。 true：表示开启。 表21 audio 参数 是否必选 参数类型 描述 audio_redirection_enable 否 Boolean 是否开启音频重定向。取值为： false：表示关闭。 true：表示开启。 play_redirection_enable 否 Boolean 是否开启播音重定向。取值为： false：表示关闭。 true：表示开启。 play_classification 否 String 播音场景。取值为： 无损播音：LossLess。 语音通话：Speech Call。 音乐播音：Music Play。 自动识别：Automatic Identification。 record_redirection_enable 否 Boolean 是否开启录音重定向。取值为： false：表示关闭。 true：表示开启。 record_classification 否 String 录音场景。取值为： 无损录音：LossLess。 语音通话：Speech Call。 音乐录音：Music Record。 自动识别：Automatic Identification。 表22 client 参数 是否必选 参数类型 描述 automatic_reconnection_interval 否 Integer 自动重连间隔（秒）。取值范围为[1-50]。默认：5。 session_persistence_time 否 Integer 自动重连会话保持时长（秒）。取值范围为[0-180]。默认：180。 forbid_screen_capture 否 Boolean 防截屏策略开关。 false：表示关闭。 true：表示开启。 表23 display 参数 是否必选 参数类型 描述 display_level 否 String 显示级别。取值为： LEVEL1：表示等级1。 LEVEL2：表示等级2。 LEVEL3：表示等级3。 LEVEL4：表示等级4（默认/推荐）。 LEVEL5：表示等级5。 options 否 DisplayOptions object 显示级别共同控制的选项。 rendering_acceleration_enable 否 Boolean 是否开启渲染加速。取值为： false：表示关闭。 true：表示开启。 rendering_acceleration_options 否 rendering_acceleration_options object 渲染加速控制选项。 video_card_memory_size 否 Integer 显卡缓存（MB）。取值范围为[0-64]。默认：64。 driver_delegation_mode_enable 否 Boolean 是否开启驱动托管模式。取值为： false：表示关闭。 true：表示开启。 driver_delegation_latency 否 Integer 驱动托管延时（*30ms）。取值范围为[1-100]。默认：80。 video_latency 否 Integer 驱动托管视频延时（*30ms）。取值范围为[1-100]。默认：80。 change_resolution_vm 否 Boolean 计算机修改分辨率：取值为： false：表示关闭。 true：表示开启。 表24 DisplayOptions 参数 是否必选 参数类型 描述 display_bandwidth 否 Integer 带宽（Kbps）。取值范围为[256-25000]。默认：20000。 frame_rate 否 Integer 帧率（fps）。取值范围为[1-60]。默认：25。 video_frame_rate 否 Integer 视频帧率（fps）。取值范围为[1-60]。默认：30。 min_image_cache 否 Integer 图像缓存最低容量（MB）。取值范围[0-300]，默认：200。 smoothing_factor 否 Integer 有损压缩识别阈值。取值范围为[0-255]。默认：60。 lossless_compression_mode 否 String 无损压缩模式。取值为： Basic Compression：表示初级压缩。 Deep Compression：表示深度压缩。 deep_compression_options 否 deep_compression_options object 深度压缩控制选项。 lossy_compression_quality 否 Integer 有损压缩质量。取值范围为[20-100]。默认：85。 color_enhancement_enable 否 Boolean 办公场景色彩增强：取值为： false：表示关闭。 true：表示开启。 quality_bandwidth_first 否 String 质量或带宽优先。取值为： Quality First：表示初级压缩。 Bandwidth First：表示深度压缩。 video_bit_rate_options 否 video_bit_rate_options object 视频码率控制选项。 peak_video_bit_rate 否 Integer 视频峰值码率（Kbps）。取值范围为[256-100000]。默认：18000。 video_quality_options 否 video_quality_options object 视频质量控制选项。 gop_size 否 Integer GOP大小。取值范围为[0-65535]。默认：100。 encoding_preset 否 String 编码预置。取值为： 预置1：Preset 1。 预置2：Preset 2。 预置3：Preset 3。 预置4：Preset 4。 预置5：Preset 5。 预置6：Preset 6。 预置7：Preset 7。 表25 deep_compression_options 参数 是否必选 参数类型 描述 deep_compression_level 否 String 深度压缩级别。取值为： 压缩级别0：Compression grade 0 压缩级别1：Compression grade 1 压缩级别2：Compression grade 2 压缩级别3：Compression grade 3 压缩级别4：Compression grade 4 压缩级别5：Compression grade 5 压缩级别6：Compression grade 6 压缩级别7：Compression grade 7 压缩级别8：Compression grade 8 压缩级别9：Compression grade 9 表26 video_bit_rate_options 参数 是否必选 参数类型 描述 average_video_bit_rate 否 Integer 视频平均码率（Kbps）。取值范围为[256-100000]。默认：18000。 表27 video_quality_options 参数 是否必选 参数类型 描述 average_video_quality 否 Integer 视频平均质量。取值范围为[5-59]。默认：15。 lowest_video_quality 否 Integer 视频最低质量。取值范围为[5-69]。默认：25。 highest_video_quality 否 Integer 视频最高质量。取值范围为[1-59]。默认：7。 表28 rendering_acceleration_options 参数 是否必选 参数类型 描述 video_acceleration_enhancement_enable 否 Boolean 视频加速增强配置。取值为： false：表示关闭。 true：表示开启。 video_optimization_enable 否 Boolean 是否开启视频场景优化。取值为： false：表示关闭。 true：表示开启。 gpu_color_optimization_enable 否 Boolean 是否开启GPU色彩优化。取值为： false：表示关闭。 true：表示开启。 表29 file_and_clipboard 参数 是否必选 参数类型 描述 bypass_in_remote_app_enable 否 Boolean 应用聚合场景下是否双向放通：取值为： false：表示不放通。 true：表示放通。 file_redirection 否 file_redirection object 文件重定向。 fd_mobile_client_redir_enable 否 Boolean 移动客户端文件重定向：取值为： false：表示关闭。 true：表示开启。 clipboard_redirection 否 String 剪切板重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_redirection_options 否 clipboard_redirection_options object 剪切板重定向控制的选项。 表30 file_redirection 参数 是否必选 参数类型 描述 redirection_mode 否 String 文件重定向。取值为： DISABLED：表示禁用。（默认） READ_ONLY：表示只读。 READ_AND_WRITE：表示读写。 options 否 FileRedirectionOptions object 文件重定向控制的选项。 vm_send_file_client 否 Boolean 是否开启发送文件（虚机到客户端）。取值为： false：表示关闭。 true：表示开启。 redirection_send_file_options 否 redirection_send_file_options object 重定向和发送文件共同控制项。 表31 FileRedirectionOptions 参数 是否必选 参数类型 描述 fluid_control_switch_enable 否 Boolean 是否开启流控开关。取值为： false：表示关闭。 true：表示开启。 fluid_control_options 否 fluid_control_options object 流控控制项。 compression_switch_enable 否 Boolean 是否开启压缩开关。取值为： false：表示关闭。 true：表示开启。 compression_switch_options 否 compression_switch_options object 压缩开关控制项。 linux_file_size_supported_enable 否 Boolean 是否开启Linux支持设置文件大小。取值为： false：表示关闭。 true：表示开启。 linux_file_size_supported_options 否 linux_file_size_supported_options object Linux支持设置文件大小控制项。 linux_root_mount_switch_enable 否 Boolean 是否开启Linux根目录挂载开关。取值为： false：表示关闭。 true：表示开启。 linux_root_dir_list 否 String Linux根目录挂载路径。默认："\home"。 linux_file_mount_path 否 String Linux文件系统挂载路径。默认："\media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media"。 linux_fixed_drive_file_system_format 否 String Linux固定驱动器文件系统格式。 linux_removable_drive_file_system_format 否 String Linux可移动驱动器文件系统格式。默认："vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir"。 linux_cdrom_drive_file_system_format 否 String Linux光盘驱动器文件系统格式。默认："cd9660|iso9660|udf"。 linux_network_drive_file_system_format 否 String Linux网络驱动器文件系统格式。默认："smbfs|afpfs|cifs"。 path_separator 否 String 路径分隔符。默认："|"。 fixed_drive_enable 否 Boolean 是否开启固定驱动器（如: 本地磁盘）。取值为： false：表示关闭。 true：表示开启。 removable_drive_enable 否 Boolean 是否开启可移除驱动器（如: U盘）。取值为： false：表示关闭。 true：表示开启。 cd_rom_drive_enable 否 Boolean 是否开启光盘驱动器。取值为： false：表示关闭。 true：表示开启。 network_drive_enable 否 Boolean 是否开启网络驱动器。取值为： false：表示关闭。 true：表示开启。 表32 fluid_control_options 参数 是否必选 参数类型 描述 good_network_latency 否 Integer 网络优的延时阈值（ms）。取值范围为[1-1000]。默认：30。 normal_network_latency 否 Integer 网络一般的延时阈值（ms）。取值范围为[1-1000]。默认：70。 poor_network_latency 否 Integer 网络差的延时阈值（ms）。取值范围为[1-1000]。默认：100。 reducing_step 否 Integer 降速步伐（KB）。取值范围为[1-100]。默认：20。 slow_increasing_step 否 Integer 慢增速步伐（KB）。取值范围为[1-100]。默认：10。 quick_increasing_step 否 Integer 快增速步伐（KB）。取值范围为[1-100]。默认：20。 start_speed 否 Integer 传输初始速度（KB/s）。取值范围为[1-10240]。默认：1024。 test_block_size 否 Integer 测速块大小（KB）。取值范围为[64-1024]。默认：64。 test_time_gap 否 Integer 测速块时间间隔（ms）。取值范围为[1000-100000]。默认：10000。 表33 compression_switch_options 参数 是否必选 参数类型 描述 compression_threshold 否 Integer 压缩阈值（Byte）。取值范围为[0-10240]。默认：512。 minimum_compression_rate 否 Integer 最小压缩率。取值范围为[0-1000]。默认：900。 表34 linux_file_size_supported_options 参数 是否必选 参数类型 描述 linux_file_size_supported_threshold 否 Integer Linux设置文件大小阈值（Byte）。取值范围为[0-4096]。默认：100。 表35 redirection_send_file_options 参数 是否必选 参数类型 描述 read_write_speed 否 Integer 读写速度（Kbps）。取值范围为[0-2147483647]。默认：0。 表36 clipboard_redirection_options 参数 是否必选 参数类型 描述 rich_text_redirection_enable 否 Boolean 是否开启剪切板富文本重定向。取值为： false：表示关闭。 true：表示开启。 rich_text_clipboard_redirection 否 String 剪切板富文本重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_file_redirection_enable 否 Boolean 是否开启剪切板文件重定向。取值为： false：表示关闭。 true：表示开启。 file_clipboard_redirection 否 String 剪切板文件重定向。取值为： DISABLED：表示禁用。（默认） SERVER_TO_CLIENT_ENABLED：表示开启服务端到客户端。 CLIENT_TO_SERVER_ENABLED：表示开启客户端到服务端。 TWO_WAY_ENABLED：表示开启双向。 clipboard_length_limit_cts_enable 否 Boolean 本地到虚拟机长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_cts 否 Integer 本地到虚拟机长度限制。 clipboard_length_limit_stc_enable 否 Boolean 虚拟机到本地到长度限制开关。取值为： false: 标识关闭。 ture: 标识开启。 clipboard_length_limit_stc 否 Integer 虚拟机到本地长度限制。 表37 Session 参数 是否必选 参数类型 描述 sbc 否 Sbc object SBC结构体。 表38 Sbc 参数 是否必选 参数类型 描述 sbc_automatic_disconnection 否 String 连接策略： DISABLED：已禁用 AUTO_DISCONNECT：自动断开 AUTO_LOCK：自动锁屏 sbc_automatic_disconnection_options 否 SbcAutomaticDisconnectionOptions object 自动连接选项。 表39 SbcAutomaticDisconnectionOptions 参数 是否必选 参数类型 描述 disconnection_waiting_time 否 Integer 等待时间（分钟）。 sbc_auto_logout 否 Boolean 是否自动注销。取值为：false：表示是。true：表示否。 auto_logout_options 否 AutoLogoutOptions object 自动注销。 表40 AutoLogoutOptions 参数 是否必选 参数类型 描述 sbc_logout_waiting_time 否 Integer 会话断连保留时长（分钟）。 表41 VirtualChannel 参数 是否必选 参数类型 描述 virtual_channel_control_enable 否 Boolean 是否开启虚拟通道策略设置。取值为：false：表示关闭。true：表示开启。 options 否 VirtualChannelOptions object 虚拟通道策略控制的选项。 表42 VirtualChannelOptions 参数 是否必选 参数类型 描述 custom_virtual_channel_name 否 String 自定义虚拟通道注册名。 virtual_channel_plugin_details 否 String 虚拟通道下载配置信息，需Base64加密。 third_party_plugin_name 否 String 第三方插件名称。 表43 keyboard_mouse 参数 是否必选 参数类型 描述 mouse_feedback 否 String 虚拟机鼠标回馈。取值为： SELFADAPTION：自适应鼠标回馈。 FORCE：强制鼠标回馈。 CLOSE：关闭鼠标回馈。 mouse_simulation_mode 否 String 虚拟机鼠标模拟方式。取值为： ABSOLUTE_POSITION：绝对位置模拟。 RELATIVE_POSITION：相对位置模拟。 external_cursor_feedback 否 Boolean 虚拟机外部光标反馈。取值为： false：表示关闭。 true：表示开启。 表44 Bandwidth 参数 是否必选 参数类型 描述 intelligent_data_transport_flag 否 String 智能显示传输。取值为：DISABLE：表示关闭。ENABLE：表示开启。DIAGNOSTIC：诊断模式。 total_bandwidth_control_enable 否 Boolean 是否开启总带宽控制。取值为：false：表示关闭。true：表示开启。 options 否 TotalBandwidthControlOptions object 总带宽控制的选项。 display_bandwidth_control_enable 否 Boolean 是否开启显示带宽控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_control_options 否 DisplayBandwidthControlOptions object 显示带宽控制的选项。 multimedia_bandwidth_control_enable 否 Boolean 是否开启多媒体带宽控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_control_options 否 MultimediaBandwidthControlOptions object 多媒体带宽控制的选项。 usb_bandwidth_control_enable 否 Boolean 是否开启USB带宽控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_control_options 否 UsbBandwidthControlOptions object USB带宽控制的选项。 pcsc_bandwidth_control_enable 否 Boolean 是否开启PCSC控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_control_options 否 PcscBandwidthControlOptions object PCSC带宽控制的选项。 twain_bandwidth_control_enable 否 Boolean 是否开启TWAIN带宽控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_control_options 否 TwainBandwidthControlOptions object TWAIN带宽控制的选项。 printer_bandwidth_control_enable 否 Boolean 是否开启打印机带宽控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_control_options 否 PrinterBandwidthControlOptions object 打印机带宽控制的选项。 com_bandwidth_control_enable 否 Boolean 是否开启串口带宽控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_control_options 否 ComBandwidthControlOptions object 串口带宽控制的选项。 file_redirection_bandwidth_control_enable 否 Boolean 是否开启文件重定向带宽控制。取值为：false：表示关闭。true：表示开启 file_redirection_bandwidth_control_options 否 FileRedirectionBandwidthControlOptions object 文件重定向带宽控制的选项。 clipboard_bandwidth_control_enable 否 Boolean 是否开启剪切板带宽控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_control_options 否 ClipboardBandwidthControlOptions object 剪切板带宽控制的选项。 secure_channel_bandwidth_control_enable 否 Boolean 是否开启安全通道带宽控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_control_options 否 SecureChannelBandwidthControlOptions object 安全通道带宽控制的选项。 camera_bandwidth_control_enable 否 Boolean 是否开启摄像头带宽控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_control_options 否 CameraBandwidthControlOptions object 摄像头带宽控制的选项。 virtual_channel_bandwidth_control_enable 否 Boolean 是否开启虚拟通道带宽控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_control_options 否 VirtualChannelBandwidthControlOptions object 虚拟通道带宽控制的选项。 表45 TotalBandwidthControlOptions 参数 是否必选 参数类型 描述 total_bandwidth_control_value 否 Integer 总带宽控制量（Kbps）。取值范围为[10000-1000000]。默认：30000。 display_bandwidth_percentage_enable 否 Boolean 显示带宽百分比控制。取值为：false：表示关闭。true：表示开启。 display_bandwidth_percentage_options 否 DisplayBandwidthPercentageOptions object 显示带宽百分比控制的选项。 multimedia_bandwidth_percentage_enable 否 Boolean 多媒体带宽百分比控制。取值为：false：表示关闭。true：表示开启。 multimedia_bandwidth_percentage_options 否 MultimediaBandwidthPercentageOptions object 多媒体带宽百分比控制的选项。 usb_bandwidth_percentage_enable 否 Boolean USB带宽百分比控制。取值为：false：表示关闭。true：表示开启。 usb_bandwidth_percentage_options 否 UsbBandwidthPercentageOptions object USB带宽百分比控制的选项。 pcsc_bandwidth_percentage_enable 否 Boolean PCSC带宽百分比控制。取值为：false：表示关闭。true：表示开启。 pcsc_bandwidth_percentage_options 否 PcscBandwidthPercentageOptions object PCSC带宽百分比控制的选项。 twain_bandwidth_percentage_enable 否 Boolean TWAIN带宽百分比控制。取值为：false：表示关闭。true：表示开启。 twain_bandwidth_percentage_options 否 TwainBandwidthPercentageOptions object TWAIN带宽百分比控制的选项。 printer_bandwidth_percentage_enable 否 Boolean 打印机带宽百分比控制。取值为：false：表示关闭。true：表示开启。 printer_bandwidth_percentage_options 否 PrinterBandwidthPercentageOptions object 打印机带宽百分比控制的选项。 com_bandwidth_percentage_enable 否 Boolean 串口带宽百分比控制。取值为：false：表示关闭。true：表示开启。 com_bandwidth_percentage_options 否 ComBandwidthPercentageOptions object 串口带宽百分比控制的选项。 file_redirection_bandwidth_percentage_enable 否 Boolean 文件重定向带宽百分比控制。取值为：false：表示关闭。true：表示开启。 file_redirection_bandwidth_percentage_options 否 FileRedirectionBandwidthPercentageOptions object 文件重定向带宽百分比控制的选项。 clipboard_bandwidth_percentage_enable 否 Boolean 剪切板带宽百分比控制。取值为：false：表示关闭。true：表示开启。 clipboard_bandwidth_percentage_options 否 ClipboardBandwidthPercentageOptions object 剪切板带宽百分比控制的选项。 secure_channel_bandwidth_percentage_enable 否 Boolean 安全通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 secure_channel_bandwidth_percentage_options 否 SecureChannelBandwidthPercentageOptions object 安全通道带宽百分比控制的选项。 camera_bandwidth_percentage_enable 否 Boolean 摄像头带宽百分比控制。取值为：false：表示关闭。true：表示开启。 camera_bandwidth_percentage_options 否 CameraBandwidthPercentageOptions object 摄像头带宽百分比控制的选项。 virtual_channel_bandwidth_percentage_enable 否 Boolean 虚拟通道带宽百分比控制。取值为：false：表示关闭。true：表示开启。 virtual_channel_bandwidth_percentage_options 否 VirtualChannelBandwidthPercentageOptions object 虚拟通道带宽百分比控制的选项。 表46 DisplayBandwidthPercentageOptions 参数 是否必选 参数类型 描述 display_bandwidth_percentage_value 否 Integer 显示带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表47 MultimediaBandwidthPercentageOptions 参数 是否必选 参数类型 描述 multimedia_bandwidth_percentage_value 否 Integer 多媒体带宽百分比控制量（%）。取值范围为[0-100]。默认：50。 表48 UsbBandwidthPercentageOptions 参数 是否必选 参数类型 描述 usb_bandwidth_percentage_value 否 Integer USB带宽百分比控制量（%）。取值范围为[0-100]。默认：100。 表49 PcscBandwidthPercentageOptions 参数 是否必选 参数类型 描述 pcsc_bandwidth_percentage_value 否 Integer PCSC带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表50 TwainBandwidthPercentageOptions 参数 是否必选 参数类型 描述 twain_bandwidth_percentage_value 否 Integer TWAIN带宽百分比控制量（%）。取值范围为[0-100]。默认：15。 表51 PrinterBandwidthPercentageOptions 参数 是否必选 参数类型 描述 printer_bandwidth_percentage_value 否 Integer 打印机带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表52 ComBandwidthPercentageOptions 参数 是否必选 参数类型 描述 com_bandwidth_percentage_value 否 Integer 串口带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表53 FileRedirectionBandwidthPercentageOptions 参数 是否必选 参数类型 描述 file_redirection_bandwidth_percentage_value 否 Integer 文件重定向带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表54 ClipboardBandwidthPercentageOptions 参数 是否必选 参数类型 描述 clipboard_bandwidth_percentage_value 否 Integer 剪切板带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表55 SecureChannelBandwidthPercentageOptions 参数 是否必选 参数类型 描述 secure_channel_bandwidth_percentage_value 否 Integer 安全通道带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表56 CameraBandwidthPercentageOptions 参数 是否必选 参数类型 描述 camera_bandwidth_percentage_value 否 Integer 摄像头带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表57 VirtualChannelBandwidthPercentageOptions 参数 是否必选 参数类型 描述 virtual_channel_bandwidth_percentage_value 否 Integer 虚拟通道带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表58 DisplayBandwidthControlOptions 参数 是否必选 参数类型 描述 display_bandwidth_control_value 否 Integer 显示带宽控制量（Kbps）。取值范围为[500-50000]。默认：20000。 表59 MultimediaBandwidthControlOptions 参数 是否必选 参数类型 描述 multimedia_bandwidth_control_value 否 Integer 多媒体带宽控制量（Kbps）。取值范围为[5000-20000]。默认：15000。 表60 UsbBandwidthControlOptions 参数 是否必选 参数类型 描述 usb_bandwidth_control_value 否 Integer USB带宽控制量（Kbps）。取值范围为[1000-30000]。默认：30000。 表61 PcscBandwidthControlOptions 参数 是否必选 参数类型 描述 pcsc_bandwidth_control_value 否 Integer PCSC带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表62 TwainBandwidthControlOptions 参数 是否必选 参数类型 描述 twain_bandwidth_control_value 否 Integer TWAIN带宽控制量（Kbps）。取值范围为[2000-10000]。默认：5000。 表63 PrinterBandwidthControlOptions 参数 是否必选 参数类型 描述 printer_bandwidth_control_value 否 Integer 打印机带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表64 ComBandwidthControlOptions 参数 是否必选 参数类型 描述 com_bandwidth_control_value 否 Integer 串口带宽控制量（Kbps）。取值范围为[500-2000]。默认：1000。 表65 FileRedirectionBandwidthControlOptions 参数 是否必选 参数类型 描述 file_redirection_bandwidth_control_value 否 Integer 文件重定向带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表66 ClipboardBandwidthControlOptions 参数 是否必选 参数类型 描述 clipboard_bandwidth_control_value 否 Integer 剪切板带宽控制量（Kbps）。取值范围为[100-2000]。默认：1000。 表67 SecureChannelBandwidthControlOptions 参数 是否必选 参数类型 描述 secure_channel_bandwidth_control_value 否 Integer 安全通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表68 CameraBandwidthControlOptions 参数 是否必选 参数类型 描述 camera_bandwidth_control_value 否 Integer 摄像头带宽控制量（Kbps）。取值范围为[0-10000]。默认：10000。 表69 VirtualChannelBandwidthControlOptions 参数 是否必选 参数类型 描述 virtual_channel_bandwidth_control_value 否 Integer 虚拟通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：20000。 表70 custom 参数 是否必选 参数类型 描述 custom_configuration1_enable 否 Boolean 自定义策略配置项1： false: 表示关闭 true: 表示开启 options 否 CustomOptions object 自定义策略设置项。 表71 CustomOptions 参数 是否必选 参数类型 描述 custom_configuration1_rule 否 String 配置项1内容。

请求示例 /v2/{project_id}/desktops/resource_instances/action { "offset" : "100", "limit" : "100", "action" : "filter", "matchs" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 否 String 默认为0 limit 否 String 默认为1000 action 否 String 如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可 without_any_tag 否 Boolean 包含任意一个标签,该字段为true时查询所有不带标签的资源 matches 否 Array of Match objects match对象 tags 否 Array of Tags objects 包含的标签对象，只要有一个不包含，就不符合，一个key对应多个value tags_any 否 Array of Tags objects 包含任意标签，若全都不包含，不符合，一个key对应多个value not_tags 否 Array of Tags objects 不包含标签，只要有一个不包含，就符合了，一个key对应多个value not_tags_any 否 Array of Tags objects 不包含任意标签，只要包含其中一个，就不符合，一个key对应多个value 表4 Match 参数 是否必选 参数类型 描述 key 是 String 搜索时要匹配的字段 value 是 String 搜索时匹配的值，当key=resource_name时为模糊匹配 表5 Tags 参数 是否必选 参数类型 描述 key 否 String 标签key。 values 否 Array of strings 标签value。