虚拟通道 管理员可以通过配置“虚拟通道”策略的方式，实现用户通过华为云办公客户端进入 云桌面 ，下载插件使用的目的。虚拟通道策略内容如表9所示。 表9 虚拟通道策略 策略参数 策略说明 取值样例 虚拟通道控制 ：启用虚拟通道控制策略。 ：禁用虚拟通道控制策略。默认为禁用状态。 自定义虚拟通道注册名 请联系华为技术支持获取。 - 虚拟通道下载配置信息 请联系华为技术支持获取。 - 第三方插件名称 用于客户端按需加载指定第三方插件（限Windows客户端），如：LyncVdiPluginLib。可输入多个插件名称，采用空格或英文逗号（,）分隔。 LyncVdiPluginLib

键盘鼠标 配置键盘鼠标策略。策略内容如表10所示。 表10 键盘鼠标策略 策略参数 策略说明 推荐值 计算机鼠标回馈 自适应鼠标回馈。 强制鼠标回馈。 关闭鼠标回馈。 自适应鼠标回馈 计算机鼠标模拟方式 绝对位置模拟。 相对位置模拟。 绝对位置模拟 自助维护台抢占登录 该配置项用于控制当用户云桌面处于已登录状态时，通过自助维护台是否允许抢占登录。 计算机外部光标反馈 ：启用虚拟机外部光标反馈。 ：禁用虚拟机外部光标反馈。

会话 配置会话策略。策略内容如表6所示。 表6 会话策略 策略参数 策略说明 推荐值 自动锁屏 ：启用自动锁屏。连接桌面时，经过锁屏等待时间，客户端依然无键鼠来源且桌面内无应用设置系统为使用状态，云桌面将自动锁屏。 ：关闭自动锁屏。 说明： 对于23.8.2及之后版本HDA的Windows桌面，支持在桌面内有应用（例如视频播放器、会议软件等）设置系统为使用状态时，识别到桌面为使用状态，不会触发对应自动策略。 已禁用 锁屏等待时间（分钟） 云桌面屏幕自动锁定前的等待时间，范围是3~86400。 10 锁屏后自动断开/注销/重启/关机/休眠 锁屏后自动断开：自动锁屏开启后，再启用自动断开，触发自动锁屏后，再经过等待时间，客户端依然无键鼠来源且桌面内无应用设置系统为使用状态，虚拟机将自动断开。 锁屏后自动注销：自动锁屏开启后，再启用自动注销，触发自动锁屏后，再经过等待时间，客户端依然无键鼠来源且桌面内无应用设置系统为使用状态，虚拟机将自动注销。 锁屏后自动重启：自动锁屏开启后，再启用自动重启，触发自动锁屏后，再经过等待时间，客户端依然无键鼠来源且桌面内无应用设置系统为使用状态，虚拟机将自动重启。 锁屏后自动关机：自动锁屏开启后，再启用自动关机，触发自动锁屏后，再经过等待时间，客户端依然无键鼠来源且桌面内无应用设置系统为使用状态，虚拟机将自动关机。 锁屏后自动休眠：自动锁屏开启后，再启用自动休眠，触发自动锁屏后，再经过等待时间，客户端依然无键鼠来源且桌面内无应用设置系统为使用状态，虚拟机将自动休眠。 已禁用：关闭自动断开/注销/重启/关机或休眠。 已禁用 锁屏后自动断开/注销/重启/关机/休眠等待时间（分钟） 云桌面自动断开/注销/重启/关机或休眠前的等待时间，范围是1~86400。 1440 断开后自动注销/重启/关机/休眠 注销：断开客户端接入后，经过等待时间，仍未重新连接虚拟机，虚拟机将自动注销。 重启：断开客户端接入后，经过等待时间，仍未重新连接虚拟机，虚拟机将自动重启。 关机：断开客户端接入后，经过等待时间，仍未重新连接虚拟机，虚拟机将自动关机。 休眠：断开客户端接入后，经过等待时间，仍未重新连接虚拟机，虚拟机将自动休眠。 禁用：关闭自动断开/注销/重启/关机或休眠。 说明： 仅当锁屏后自动断开/注销/重启/关机/休眠功能选择断开或禁用时，才能使用断开后自动注销/重启/关机/休眠功能。 等待时间内若虚拟机发生了其他注销、重启或关机任务，则本次不会触发自动注销/重启/关机/休眠操作。 已禁用 断开后自动注销/重启/关机/休眠等待时间（分钟） 云桌面断开后自动注销/重启/关机/休眠前的等待时间，范围是10~86400。 10 自助维护台抢占登录 该配置项用于控制当用户云桌面处于已登录状态时，通过自助维护台是否允许抢占登录。设置为表示可以抢占，表示不允许抢占。默认为可抢占登录。该配置需要重启云桌面。

通用音视频旁路 用户在Windows 10操作系统的本地终端上安装了应用和华为云办公客户端，可以通过配置“通用音视频旁路”策略的方式，实现通过华为云办公客户端进入云桌面，即可使用本地终端上的应用的目的，无需再在云桌面中安装待使用的应用。通用音视频旁路策略内容如表8所示。 使用通用音视频旁路功能还存在如下限制： 只在本地终端的操作系统为Windows 10，且云桌面的操作系统为Windows时可用。 在本地终端打开非云桌面应用无异常，且能正常使用，才可通过通用音视频旁路策略映射到云桌面中使用。 登录云桌面使用通过音视频旁路策略映射到云桌面中的应用前，需要关闭本地终端上已开启的应用。否则无法在云桌面中使用该应用。 在云桌面中使用通过音视频旁路策略映射到云桌面中的应用前，需确保云桌面为全屏状态。 在云桌面中使用通过音视频旁路策略映射到云桌面中的应用时，无法使用云桌面中的其他应用与该应用进行交互。例如，无法使用云桌面中的截图软件截取应用界面。 应用使用的输入法为终端侧输入法。在云桌面中使用通过音视频旁路策略映射到云桌面中的应用时，如果需要切换输入法，需要切换本地终端的输入法。例如，通过键盘快捷键切换输入法或者最小化云桌面在本地桌面中切换输入法。 在云桌面中使用通过音视频旁路策略映射到云桌面中的应用时，使用“Alt+Tab”快捷组合键切换窗口，会切换至本地终端界面。 如果当前云桌面开启了“USB端口重定向”中的“视频设备（如：摄像头）”策略，则在当前云桌面中使用通过音视频旁路策略映射到云桌面中的应用进行视频相关操作时，无法使用本地终端上的摄像头。 在云桌面中使用通过音视频旁路策略映射到云桌面中的应用时，如果需要在应用和云桌面之间复制文本，需要云桌面开启剪切板重定向策略，具体策略配置可参考如何控制云桌面与本地存储设备之间的文件复制。 使用通过音视频旁路策略将本地应用映射到云桌面中后，不建议再在云桌面中使用软件包安装该应用，否则通过网页方式拉起应用时，会启动云桌面中通过软件包安装的应用。 表8 通用音视频旁路策略 策略参数 策略说明 取值样例 启用通用音视频旁路 ：启用通用音视频旁路策略。 ：禁用通用音视频旁路策略。默认为禁用状态。 软件路径 用于配置使用通用音视频旁路策略的软件安装路径、启动参数。 多个软件使用“;”隔开。如果安装路径中包含空格，需要用双引号（""）引用路径。例如： C:\Windows\System32\notepad.exe hello.txt;"C:\Program Files (x86)\Notepad++.exe" hello.txt; 说明： C:\Windows\System32\notepad.exe为本地PC上对应软件的安装路径，可在本地PC上找到软件安装后的快捷方式，单击右键，选择“属性”，在应用属性的“快捷方式”页签中，使用“目标”中的内容替换。 hello.txt为本地PC上对应软件的启动参数，需根据实际软件是否存在启动参数进行配置，存在则配置，不存在则不需配置。例如，华为云会议不存在启动参数，则无需配置。 C:\Users\用户名\AppData\Roaming\HuaweiMeeting\HuaweiMeeting\HuaweiMeeting.exe

文件和剪切板 配置文件和剪切板策略。策略内容如表5所示。 表5 文件和剪切板策略 策略类型 策略参数 策略说明 取值样例 文件重定向 文件重定向开关 只读，对选择的驱动器和存储设备中的文件只可以预览。 读写，对选择的驱动器存储设备中的文件可编辑修改。 在云桌面环境下实现对驱动器的支持，用户可以在云桌面中通过文件重定向方式使用驱动器。 只读 固定驱动器 ：选择后用户可以在云桌面中通过文件重定向方式使用固定驱动器，如本地磁盘。 ：未选择则用户无法在云桌面中通过文件重定向方式使用固定驱动器，如本地磁盘。 说明： 文件重定向关闭时，为禁用。 可移除驱动器 ：选择后用户可以在云桌面中通过文件重定向方式使用可移除驱动器，如U盘。 ：未选择则用户无法在云桌面中通过文件重定向方式使用可移除驱动器，如U盘。 说明： 文件重定向关闭时，为禁用。 光盘驱动器 ：选择后用户可以在云桌面中通过文件重定向方式使用光盘驱动器。 ：未选择则用户无法在云桌面中通过文件重定向方式使用光盘驱动器。 网络驱动器 ：选择后用户可以在云桌面中通过文件重定向方式使用网络驱动器。 ：未选择则用户无法在云桌面中通过文件重定向方式使用网络驱动器。 流控开关 ：启用流控开关。 ：关闭流控开关。 网络优的延时阈值（ms） 网络优良时的延时阈值，取值范围1~1000。 30 网络一般的延时阈值（ms） 网络一般时的延时阈值，取值范围1~1000。 70 网络差的延时阈值（ms） 网络较差时的延时阈值，取值范围1~1000。 100 降速步伐（KB） 降低传输速度的步伐，取值范围1~100。 20 慢增速步伐（KB） 慢增加传输速度的步伐，取值范围1~100。 10 快增速步伐（KB） 快增加传输速度的步伐，取值范围1~100。 20 传输初始速度（KB/s） 初始的开始传输速度，取值范围1~10240。 1024 测速块大小（KB） 测试速度的数据块大小，取值范围64~1024。 64 测速块时间间隔（ms） 发送测试数据块的时间间隔，取值范围1000~100000。 10000 压缩开关 ：启用压缩开关。 ：关闭压缩开关。 压缩阈值（Byte） 取值范围0~10240。 512 最小压缩率 取值范围0~1000。 900 Linux支持设置文件大小 ：启用Linux支持设置文件大小。 ：关闭Linux支持设置文件大小。 Linux设置文件大小阈值（MB） 取值范围0~4096。 100 移动客户端重定向 ：启用移动客户端重定向。 ：关闭移动客户端重定向。 Linux根目录挂载开关 ：启用Linux根目录挂载。 ：关闭Linux根目录挂载。 Linux根目录挂载路径 启用Linux根目录挂载时需配置挂载路径。最长256个字符，字符串格式UTF-8。 \var\log Linux文件系统挂载路径 最长256个字符，字符串格式UTF-8。 \media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media Linux固定驱动器文件系统格式 最长256个字符，字符串格式UTF-8。 - Linux可移动驱动器文件系统格式 最长256个字符，字符串格式UTF-8。 vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir Linux光盘驱动器文件系统格式 最长256个字符，字符串格式UTF-8。 cd9660|iso9660|udf Linux网络驱动器文件系统格式 最长256个字符，字符串格式UTF-8。 smbfs|afpfs|cifs 路径分隔符 单个ASCII字符。 | 读写速度（kbit/s） 文件重定向和文件发送（虚拟机至客户端）都关闭时，为禁用。 0表示不限制速度，其他为设置的读写速度，最小速度默认为32kbit/s，当小于32kbit/s时，默认使用32kbit/s。 0 文件发送 文件发送（虚拟机至客户端） ：选择后允许虚拟机中的文件发送至客户端中。 ：未选择则禁止虚拟机中的文件发送至客户端中。 剪切板重定向 剪切板重定向 开启双向：启用后最终用户可以在客户端云桌面复制数据并在本地桌面中粘贴，同时也可以在本地桌面中复制数据后在客户端云桌面中粘贴。 服务端到客户端：启用后最终用户只支持在客户端云桌面中复制数据并在本地桌面中粘贴。 客户端到服务端：启用后，只支持在本地桌面中复制数据并在客户端云桌面中粘贴。 说明： 仅在客户端（TC/SC）操作系统和云桌面操作系统均为Windows时，支持富文本复制、文件复制，且最多同时可复制500个文件。 当客户端（TC/SC、移动客户端）操作系统或云桌面操作系统为其他时，只支持纯文本格式复制，不支持文件复制。 开启双向 剪切板富文本重定向 ：启用剪切板富文本重定向。 ：禁止剪切板富文本重定向。 剪切板文件重定向 ：启用剪切板文件重定向。 ：禁止剪切板文件重定向。

显示 配置显示策略。策略内容如表4所示。 表4 显示策略 策略类型 策略参数 策略说明 取值样例 显示 显示策略等级 等级1：适用于512kbit/s以下的网络带宽，仅用于浏览文本文档等轻载办公场景，显示质量较低。 等级2：适用于1Mbps以下的网络带宽，仅用于浏览文本文档及静态图片等轻载办公场景，显示质量略优于等级1。 等级3：适用于4Mbps以下的网络带宽，可用于浏览文档、图片、动态网页等中载办公场景。 等级4（推荐）：适用于20Mbps以下的网络带宽，可用于流畅播放标清/高清视频，显示质量与占用带宽达到更佳平衡。 等级5：适用20Mbps以上的网络带宽，视频播放效果优。 等级4（推荐） 显示帧率 （fps） 非视频场景下的画面刷新率。该值越大，则画面与操作越流畅，但所需的网络带宽以及虚拟机的CPU占用率也会随之升高。取值范围1~60，推荐配置为15~25。 25 视频帧率（fps） 视频场景下的画面刷新率。该值越大，则视频播放越流畅，但所需的网络带宽以及虚拟机的CPU占用率也会随之升高。 说明： 启用“渲染加速”后，该项不起作用。 - 带宽（kbit/s） 单用户峰值带宽限制，取值范围256~25000。 20000 图像压缩参数 图像缓存最低容量（MB） 进行图像缓存时的缓存容量的大小，单位MB。值越大，带宽越低，但会消耗客户端内存。设定值小于50时，缓存功能停用。取值范围0~300。 200 有损压缩识别阈值 图像复杂度的判别阈值。该值越小，图像越倾向于无损画质，清晰度越高，但对网络带宽要求也相应升高，反之亦然，取值范围0~255。 60 无损压缩模式 选择无损图像压缩算法，“初级压缩”的压缩率较低，CPU占用也低；而“深度压缩”则相反，压缩率较高，但CPU占用也略微升高。 初级压缩 深度压缩级别 该项在选择“深度压缩”后生效。压缩级别越高，意味着压缩比越高，带宽占用越低，而CPU占用越高。0级压缩表示原图复制，无压缩，CPU占用最低，但带宽占用最高。 压缩级别0 有损压缩质量 该项用于设置有损压缩的图像质量。取值越大，画质越好。取值范围20~100。 85 办公场景色彩增强 该项用于办公场景色彩增强。 ：启用办公场景色彩增强。 ：禁用办公场景色彩增强。 视频压缩参数 质量或带宽优先 质量优先：选择质量优先，则以固定质量压缩视频画面。“视频平均码率”不生效，仅在启用“渲染加速”后生效。 带宽优先：选择带宽优先，则以恒定码率压缩视频画面。 “视频平均质量”、“视频最低质量”、“视频最高质量”不生效，仅在启用“渲染加速”后生效。 质量优先 视频平均码率（kbit/s） 视频压缩算法参数。在带宽优先模式下，该值越大，视频质量越好。取值范围256~100000。 18000 视频峰值码率（kbit/s） 视频压缩算法参数。该值越大，视频质量越好。取值范围256~100000。 18000 视频平均质量 视频画面的平均质量系数。在质量优先模式下，该值越大，视频质量越差。取值范围5~59。 15 视频最低质量 视频画面的质量下限。在质量优先模式下，该值越大，视频质量越差。取值范围5~69。 25 视频最高质量 视频画面的质量上限。在质量优先模式下，该值越大，视频质量越差。取值范围1~59。 7 GOP大小 视频压缩算法参数。该值越小，视频质量越好，但带宽占用越大，推荐设为视频帧率的1~2倍。取值范围0~65535。 100 编码预置 视频压缩算法参数。该值越小，编码速度越快，流畅度越好，但图像质量越差，带宽越大。 预置1 渲染加速 渲染加速 ：选择后启用渲染加速模式，提高显示流畅度。 ：未选择则禁用渲染加速。 视频加速增强配置 ：启用视频加速增强配置。 ：禁用视频加速增强配置。 视频场景优化 ：启用视频场景优化，提高视频场景的显示流畅度。 ：禁用视频场景优化。 已禁用 GPU色彩优化 ：启用GPU色彩优化，在视频/办公混合场景中提高色彩还原度。 ：禁用GPU色彩优化。 说明： 该参数仅针对GPU桌面。 视频识别阈值 进视频或切换视频状态需要的帧数。当退出视频时，值越大，越容易退；进视频时，值越大，越容易进视频。取值范围0~500。 10 帧率统计长度 视频检测阶段，统计的帧个数，值越小，越容易进入视频。取值范围2~100。 4 图像质量阈值 该值越小，越容易进入视频。取值范围0~100。 0 刷新率阈值 该值越小，越容易进入视频。取值范围1~100。 3 退出视频区域阈值 该值越小，越容易退出视频。取值范围0~100。 8 识别为视频的最小宽 值越小，越容易进入视频。取值范围0~1280。 191 识别为视频的最小高 值越小，越容易进入视频。取值范围0~1280。 191 单帧自然图像块占比阈值 该值越小，越容易进入视频。取值范围0.000001~1。 0.3 周期自然图像数目占比阈值 该值越小，越容易进入视频。取值范围0~100。 2 非自然图面积占比阈值 该值越大，越难退出视频。取值范围0.000001~1。 0.85 非自然图数目占比阈值 该值越大，越难退出视频。取值范围0~100。 25 其他参数 显卡缓存（MB） 设备表面内存容量，取值范围0~64，影响部分场景带宽，值越大，带宽越低。 64 驱动托管模式 ：启用驱动托管模式。 ：禁用驱动托管模式。 驱动托管延时（*30ms） 取值范围1~100。 80 驱动托管视频延时（*30ms） 取值范围1~100。 80 计算机修改分辨率 ：启用计算机修改分辨率策略后，终端用户可在云桌面中通过系统设置的方式修改桌面显示分辨率。 ：禁用计算机修改分辨率，终端用户不能通过系统设置的方式修改显示分辨率。 应用感知配置 针对特定应用程序，配置特定显示策略（建议由华为工程师提供）。 -

音频 配置音频策略。策略内容如表2所示。 表2 音频策略 策略项 策略参数 策略说明 取值样例 音频重定向 音频重定向总开关 用户桌面上的应用程序可以通过终端上的声音设备来录音和播音。 播音重定向 播音重定向总开关 只有在设置启用音频重定向后才生效。单独控制播音开关。 ：启用播音重定向。启用后最终用户可以可正常播音。 ：禁用播音重定向。最终用户播音时系统将无声。 播音场景 无损：音质更好，但是带宽占用最高。 语音通话：选择该场景能提供更佳的语音通话处理能力而且带宽占用最低，但音乐处理能力一般。 音乐播音：选择该场景能提供更佳的音乐处理效果且带宽占用适中，但语音通话处理能力一般。 自动识别：选择该场景能识别用户当前是在语音通话还是在播放音乐（正常自动识别准确率可高于90%）。系统会根据用户的行为自动切换到更佳算法。 音乐播音 录音重定向 录音重定向总开关 该策略项只有在设置启用音频重定向后才生效，单独控制录音开关。 ：启用录音重定向。启用后最终用户可以正常录音。 ：禁用录音重定向。最终用户录音时系统将无声。 录音场景 无损：音质更好，但是带宽占用最高。用户在网络带宽充足和网络稳定可靠的情况才建议选择该场景。录音通常不建议使用。 语音通话：此选择能提供更佳的语音通话处理能力而且带宽占用最低，但音乐处理能力一般。录音基本上都是用于录语音，建议用户选择该场景。 音乐录音：保留项。录音实践应用中很少用于音乐。录音通常不建议使用该场景。 自动识别：保留项。自动识别目前等同于选择语音通话场景。 语音通话

客户端 配置客户端策略。策略内容如表3所示。 表3 客户端策略 策略参数 策略说明 取值样例 自动重连间隔（秒） 在客户端异常断开连接后，每隔多长时间尝试连接一次。取值范围为0~50。 5 自动重连会话保持时长（秒） 在客户端异常断开连接后，自动重连最多尝试的时间。取值范围为0~180。 180 锁屏后自动关闭本地显示器 ：选择后，在虚拟机锁屏后，经过自动关闭显示器等待时间，客户端无键鼠输入，将自动关闭显示器。 说明： 仅支持TC，且嵌套登录不生效。 ：未选择则锁屏后不控制本地显示器进行关闭。 自动关闭显示器等待时间（秒） 仅在选择“锁屏后自动关闭本地显示”策略参数时有效。本地显示器在虚拟机锁屏后自动关闭前的等待时间，取值范围是10~600000。 300 防截屏策略 策略开启后，防止用户在云桌面截屏保存本地及分享。 启用防截屏策略开关。 关闭防截屏策略开关。 说明： 仅支持windows客户端、Linux瘦终端，开启后其他终端会禁止接入。

功能说明 本节定义了云桌面的各种监控指标，各项监控指标的具体含义与使用说明，详情如表1所示。 表1 云桌面支持的运维监控指标 指标ID 指标名称 指标含义 统计维度 维度赋值示例 统计类型（使用/metric接口查询的返回值计算方式） 统计周期 最大查询时间范围 最大数据保留时长 desktopUsage 桌面使用率 用于统计使用桌面数与桌面总数的比率。 单位：百分比（%） Project 无需单独传值 平均值 1小时/1天 30天 180天 dailyUserOnlineRate 每天用户使用率 指定时间段内用户使用率。 单位：百分比（%） Project 无需单独传值 平均值 1天 30天 180天 desktopUseNumber 桌面使用数 指定时间段内使用过的桌面数，同一桌面只会统计一次。 单位：（个） Project 无需单独传值 最新值 1小时/1天 30天 180天 desktop_num_per_project 桌面总数 统计Project下的桌面总数。 单位：（个） Project 无需单独传值 最新值 1小时/1天 30天 180天 excellent_network_rtt_num 优秀网络时延个数 网络时延在30ms以内的会话个数。 单位：（个） Project 无需单独传值 最新值 1小时 30天 180天 good_network_rtt_num 良好网络时延个数 网络时延在31ms-50ms的会话个数。 单位：（个） Project 无需单独传值 最新值 1小时 30天 180天 average_network_rtt_num 一般网络时延个数 网络时延在51ms-100ms的会话个数。 单位：（个） Project 无需单独传值 最新值 1小时 30天 180天 poor_network_rtt_num 较差网络时延个数 网络时延在100ms以上的会话个数。 单位：（个） Project 无需单独传值 最新值 1小时 30天 180天 up_bandwidth 上行流量 云桌面使用过程中的发送流量。 单位：字节（Byte） 登录会话 dim.0=transaction_id,TID-15171242896-1ca01b00014641e 会话级别指标无统计值，仅可查看趋势 1分钟 7天 7天 down_bandwidth 下行流量 云桌面使用过程中的接受流量。 单位：字节（Byte） 登录会话 dim.0=transaction_id,TID-15171242896-1ca01b00014641e 会话级别指标无统计值，仅可查看趋势 1分钟 7天 7天 network_rtt 网络时延 云桌面使用过程中网络数据在传输过程中所需的时间延迟。 单位：毫秒（ms） 登录会话 dim.0=transaction_id,TID-15171242896-1ca01b00014641e 会话级别指标无统计值，仅可查看趋势 1分钟 7天 7天 network_jitter 网络抖动 云桌面使用过程中网络的最大延迟与最小延迟的时间差。 单位：毫秒（ms） 登录会话 dim.0=transaction_id,TID-15171242896-1ca01b00014641e 会话级别指标无统计值，仅可查看趋势 1分钟 7天 7天

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

响应示例 状态码： 200 查询策略组策略项信息的响应。 { "policies" : { "peripherals" : { "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" : "Classical mode" } }, "device_redirection" : { "printer_redirection" : { "printer_enable" : true, "options" : { "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" }, "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 } } }, "audio" : { "audio_redirection_enable" : true, "play_redirection_enable" : true, "play_classification" : "Music Play", "record_redirection_enable" : true, "record_classification" : "Speech Call" }, "client" : { "automatic_reconnection_interval" : 5, "session_persistence_time" : 180, "forbid_screen_capture" : false }, "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" : false, "video_optimization_enable" : false, "gpu_color_optimization_enable" : false }, "video_card_memory_size" : 64, "driver_delegation_mode_enable" : false, "driver_delegation_latency" : 80, "video_latency" : 80, "change_resolution_vm" : false }, "file_and_clipboard" : { "bypass_in_remote_app_enable" : true, "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" : "\\\\home", "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", "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 } }, "fd_mobile_client_redir_enable" : true, "clipboard_redirection" : "DISABLED", "clipboard_redirection_options" : { "rich_text_redirection_enable" : true, "rich_text_clipboard_redirection" : "DISABLED", "clipboard_file_redirection_enable" : true, "file_clipboard_redirection" : "DISABLED" } }, "session" : { "sbc" : { "sbc_automatic_disconnection" : "AUTO_DISCONNECT", "sbc_automatic_disconnection_options" : { "disconnection_waiting_time" : 15, "sbc_auto_logout" : true, "auto_logout_options" : { "sbc_logout_waiting_time" : 480 } } } }, "virtual_channel" : { "virtual_channel_control_enable" : false, "options" : { "custom_virtual_channel_name" : "string", "virtual_channel_plugin_details" : "string", "third_party_plugin_name" : "string" } }, "keyboard_mouse" : { "mouse_feedback" : "SELFADAPTION", "mouse_simulation_mode" : "ABSOLUTE_POSITION", "external_cursor_feedback" : 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 } }, "custom" : { "custom_configuration1_enable" : true, "options" : { "custom_configuration1_rule" : "string" } } } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 policies Policies object 策略类。 表4 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 自定义策略 表5 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 串口重定向。 表6 usb_port_redirection 参数 参数类型 描述 usb_enable Boolean 是否开启USB端口重定向。取值为： false：表示关闭。 true：表示开启。 options UsbPortRedirectionOptions object USB端口重定向控制的选项。 表7 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：通用模式。 表8 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。 表9 printer_redirection 参数 参数类型 描述 printer_enable Boolean 是否开启打印机设备重定向。取值为： false：表示关闭。 true：表示开启。 options PrinterRedirectionOptions object 打印机设备重定向控制的选项。 表10 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。 表11 session_printer 参数 参数类型 描述 session_printer_enable Boolean 是否开启会话打印机。取值为： false：表示关闭。 true：表示开启。 options SessionPrinterOptions object 会话打印机控制选项。 表12 SessionPrinterOptions 参数 参数类型 描述 session_printer_customization_policy String 会话打印机自定义策略。 表13 camera_redirection 参数 参数类型 描述 video_compress_enable Boolean 是否开启摄像头设备重定向。取值为： false：表示关闭。 true：表示开启。 options CameraRedirectionOptions object 摄像头设备重定向控制的选项。 表14 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。 表15 usb_device_common 参数 参数类型 描述 pcsc_smart_card_enable String 是否开启PC/SC智能卡重定向。取值为： Enable：表示已启动。 Closed：表示已关闭。 Disable：表示已禁用。 common_options common_options object USB和设备智能卡共同控制的选项。 表16 common_options 参数 参数类型 描述 remove_smart_card_disconnect_enable Boolean 是否移除智能卡断开用户会话。取值为： false：表示关闭。 true：表示开启。 表17 serial_port_redirection 参数 参数类型 描述 serial_port_enable Boolean 是否开启串口重定向。取值为： false：表示关闭。 true：表示开启。 options SerialPortRedirectionOptions object 串口重定向控制的选项。 表18 SerialPortRedirectionOptions 参数 参数类型 描述 auto_connect_enable Boolean 是否自动连接客户端串口。取值为： false：表示关闭。 true：表示开启。 表19 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。 表20 client 参数 参数类型 描述 automatic_reconnection_interval Integer 自动重连间隔（秒）。取值范围为[1-50]。默认：5。 session_persistence_time Integer 自动重连会话保持时长（秒）。取值范围为[0-180]。默认：180。 forbid_screen_capture Boolean 防截屏策略开关。 false：表示关闭。 true：表示开启。 表21 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：表示开启。 表22 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。 表23 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 表24 video_bit_rate_options 参数 参数类型 描述 average_video_bit_rate Integer 视频平均码率（Kbps）。取值范围为[256-100000]。默认：18000。 表25 video_quality_options 参数 参数类型 描述 average_video_quality Integer 视频平均质量。取值范围为[5-59]。默认：15。 lowest_video_quality Integer 视频最低质量。取值范围为[5-69]。默认：25。 highest_video_quality Integer 视频最高质量。取值范围为[1-59]。默认：7。 表26 rendering_acceleration_options 参数 参数类型 描述 video_acceleration_enhancement_enable Boolean 视频加速增强配置。取值为： false：表示关闭。 true：表示开启。 video_optimization_enable Boolean 是否开启视频场景优化。取值为： false：表示关闭。 true：表示开启。 gpu_color_optimization_enable Boolean 是否开启GPU色彩优化。取值为： false：表示关闭。 true：表示开启。 表27 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 剪切板重定向控制的选项。 表28 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 重定向和发送文件共同控制项。 表29 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：表示开启。 表30 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。 表31 compression_switch_options 参数 参数类型 描述 compression_threshold Integer 压缩阈值（Byte）。取值范围为[0-10240]。默认：512。 minimum_compression_rate Integer 最小压缩率。取值范围为[0-1000]。默认：900。 表32 linux_file_size_supported_options 参数 参数类型 描述 linux_file_size_supported_threshold Integer Linux设置文件大小阈值（Byte）。取值范围为[0-4096]。默认：100。 表33 redirection_send_file_options 参数 参数类型 描述 read_write_speed Integer 读写速度（Kbps）。取值范围为[0-2147483647]。默认：0。 表34 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 虚拟机到本地长度限制。 表35 Session 参数 参数类型 描述 sbc Sbc object SBC结构体。 表36 Sbc 参数 参数类型 描述 sbc_automatic_disconnection String 连接策略： DISABLED：已禁用 AUTO_DISCONNECT：自动断开 AUTO_LOCK：自动锁屏 sbc_automatic_disconnection_options SbcAutomaticDisconnectionOptions object 自动连接选项。 表37 SbcAutomaticDisconnectionOptions 参数 参数类型 描述 disconnection_waiting_time Integer 等待时间（分钟）。 sbc_auto_logout Boolean 是否自动注销。取值为：false：表示是。true：表示否。 auto_logout_options AutoLogoutOptions object 自动注销。 表38 AutoLogoutOptions 参数 参数类型 描述 sbc_logout_waiting_time Integer 会话断连保留时长（分钟）。 表39 VirtualChannel 参数 参数类型 描述 virtual_channel_control_enable Boolean 是否开启虚拟通道策略设置。取值为：false：表示关闭。true：表示开启。 options VirtualChannelOptions object 虚拟通道策略控制的选项。 表40 VirtualChannelOptions 参数 参数类型 描述 custom_virtual_channel_name String 自定义虚拟通道注册名。 virtual_channel_plugin_details String 虚拟通道下载配置信息，需Base64加密。 third_party_plugin_name String 第三方插件名称。 表41 keyboard_mouse 参数 参数类型 描述 mouse_feedback String 虚拟机鼠标回馈。取值为： SELFADAPTION：自适应鼠标回馈。 FORCE：强制鼠标回馈。 CLOSE：关闭鼠标回馈。 mouse_simulation_mode String 虚拟机鼠标模拟方式。取值为： ABSOLUTE_POSITION：绝对位置模拟。 RELATIVE_POSITION：相对位置模拟。 external_cursor_feedback Boolean 虚拟机外部光标反馈。取值为： false：表示关闭。 true：表示开启。 表42 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 虚拟通道带宽控制的选项。 表43 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 虚拟通道带宽百分比控制的选项。 表44 DisplayBandwidthPercentageOptions 参数 参数类型 描述 display_bandwidth_percentage_value Integer 显示带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表45 MultimediaBandwidthPercentageOptions 参数 参数类型 描述 multimedia_bandwidth_percentage_value Integer 多媒体带宽百分比控制量（%）。取值范围为[0-100]。默认：50。 表46 UsbBandwidthPercentageOptions 参数 参数类型 描述 usb_bandwidth_percentage_value Integer USB带宽百分比控制量（%）。取值范围为[0-100]。默认：100。 表47 PcscBandwidthPercentageOptions 参数 参数类型 描述 pcsc_bandwidth_percentage_value Integer PCSC带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表48 TwainBandwidthPercentageOptions 参数 参数类型 描述 twain_bandwidth_percentage_value Integer TWAIN带宽百分比控制量（%）。取值范围为[0-100]。默认：15。 表49 PrinterBandwidthPercentageOptions 参数 参数类型 描述 printer_bandwidth_percentage_value Integer 打印机带宽百分比控制量（%）。取值范围为[0-100]。默认：5。 表50 ComBandwidthPercentageOptions 参数 参数类型 描述 com_bandwidth_percentage_value Integer 串口带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表51 FileRedirectionBandwidthPercentageOptions 参数 参数类型 描述 file_redirection_bandwidth_percentage_value Integer 文件重定向带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表52 ClipboardBandwidthPercentageOptions 参数 参数类型 描述 clipboard_bandwidth_percentage_value Integer 剪切板带宽百分比控制量（%）。取值范围为[0-100]。默认：3。 表53 SecureChannelBandwidthPercentageOptions 参数 参数类型 描述 secure_channel_bandwidth_percentage_value Integer 安全通道带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表54 CameraBandwidthPercentageOptions 参数 参数类型 描述 camera_bandwidth_percentage_value Integer 摄像头带宽百分比控制量（%）。取值范围为[0-100]。默认：30。 表55 VirtualChannelBandwidthPercentageOptions 参数 参数类型 描述 virtual_channel_bandwidth_percentage_value Integer 虚拟通道带宽百分比控制量（%）。取值范围为[0-100]。默认：65。 表56 DisplayBandwidthControlOptions 参数 参数类型 描述 display_bandwidth_control_value Integer 显示带宽控制量（Kbps）。取值范围为[500-50000]。默认：20000。 表57 MultimediaBandwidthControlOptions 参数 参数类型 描述 multimedia_bandwidth_control_value Integer 多媒体带宽控制量（Kbps）。取值范围为[5000-20000]。默认：15000。 表58 UsbBandwidthControlOptions 参数 参数类型 描述 usb_bandwidth_control_value Integer USB带宽控制量（Kbps）。取值范围为[1000-30000]。默认：30000。 表59 PcscBandwidthControlOptions 参数 参数类型 描述 pcsc_bandwidth_control_value Integer PCSC带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表60 TwainBandwidthControlOptions 参数 参数类型 描述 twain_bandwidth_control_value Integer TWAIN带宽控制量（Kbps）。取值范围为[2000-10000]。默认：5000。 表61 PrinterBandwidthControlOptions 参数 参数类型 描述 printer_bandwidth_control_value Integer 打印机带宽控制量（Kbps）。取值范围为[1000-5000]。默认：2000。 表62 ComBandwidthControlOptions 参数 参数类型 描述 com_bandwidth_control_value Integer 串口带宽控制量（Kbps）。取值范围为[500-2000]。默认：1000。 表63 FileRedirectionBandwidthControlOptions 参数 参数类型 描述 file_redirection_bandwidth_control_value Integer 文件重定向带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表64 ClipboardBandwidthControlOptions 参数 参数类型 描述 clipboard_bandwidth_control_value Integer 剪切板带宽控制量（Kbps）。取值范围为[100-2000]。默认：1000。 表65 SecureChannelBandwidthControlOptions 参数 参数类型 描述 secure_channel_bandwidth_control_value Integer 安全通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：10000。 表66 CameraBandwidthControlOptions 参数 参数类型 描述 camera_bandwidth_control_value Integer 摄像头带宽控制量（Kbps）。取值范围为[0-10000]。默认：10000。 表67 VirtualChannelBandwidthControlOptions 参数 参数类型 描述 virtual_channel_bandwidth_control_value Integer 虚拟通道带宽控制量（Kbps）。取值范围为[500-20000]。默认：20000。 表68 custom 参数 参数类型 描述 custom_configuration1_enable Boolean 自定义策略配置项1： false: 表示关闭 true: 表示开启 options CustomOptions object 自定义策略设置项。 表69 CustomOptions 参数 参数类型 描述 custom_configuration1_rule String 配置项1内容。 状态码： 400 表70 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表71 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表72 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表73 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表74 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表75 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表76 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码： 200 成功响应。 { "count" : 2, "items" : [ { "id" : "394", "connect_type" : "2", "user_name" : "user001@wksapp***.huawei.com", "pre_conn_time" : "2023-06-05T03:34:43Z", "start_time" : "2023-06-05T06:37:47Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418", "machine_name" : "APS-XS1QJ3TA7T", "failed_reason" : "", "failed_code" : "", "client_mac" : "c8-d9-d2-**-3a-57", "client_name" : "Y002516E2p1", "client_ip" : "10.*73.108.206", "client_version" : "23.2.2.0", "client_type" : "Windows 10", "agent_version" : "23.2.2.0423", "vm_ip" : "10.*.248.130", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-06-05T06:37:47Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" }, { "id" : "112", "connect_type" : "2", "user_name" : "nas01@wksapp***.huawei.com", "pre_conn_time" : "2023-05-23T09:10:03Z", "start_time" : "2023-05-23T09:10:04Z", "end_time" : "2023-05-23T09:16:15Z", "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1395", "machine_name" : "APS-Z5OV9E157G", "failed_reason" : "", "failed_code" : "", "client_mac" : "68-05-ca-**-c7-98", "client_name" : "kdjhfkjhdghschd", "client_ip" : "10.**.**.151", "client_version" : "23.5.0.0", "client_type" : "Windows 10", "agent_version" : "23.5.0.0519", "vm_ip" : "10.*.83.5", "connect_flag" : "0", "wi_ip" : "192.**.10.*00\\#192.**.10.23", "update_time" : "2023-05-23T09:16:15Z", "tenant_id" : "a4da8115c9d8464ead3a38309130523f", "virtual_ip" : "" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of UserConnectionInfo objects 应用使用记录列表。 表6 UserConnectionInfo 参数 参数类型 描述 id String 主键。 connect_type String 连接类型。 user_name String 登录用户。 desktop_group_name String 桌面组名。 pre_conn_time String 预连接时间。 start_time String 开始时间。 end_time String 结束时间。 machine_sid String 应用服务器sid。 machine_name String 应用服务器名称。 failed_reason String 连接失败原因。 failed_code String 连接失败状态码。 client_mac String 客户端Mac。 client_name String 客户端名称。 client_ip String 客户端ip。 client_version String 客户端版本。 client_type String 客户端操作系统类型。 agent_version String aps hda版本。 vm_ip String 应用服务器ip。 connect_flag String 连接标志。 wi_ip String 连接IP。 update_time String 更新时间。 tenant_id String 租户id。 virtual_ip String 会话虚拟ip。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 415 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 登录记录唯一标识ID。 connect_type 否 String 用户连接类别。 user_name 否 String 登录用户名称。 machine_sid 否 String 应用服务器sid。 machine_name 否 String 应用服务器名称。 failed_reason 否 String 连接失败原因。 failed_code 否 String 连接失败状态码。 client_name 否 String 客户端名称。 client_version 否 String 客户端版本。 client_type 否 String 客户端操作系统类型。 agent_version 否 String aps hda版本。 vm_ip 否 String 应用服务器ip。 connect_flag 否 String 连接标志，目前值为0。 wi_ip 否 String 连接IP。 update_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 tenant_id 否 String 租户id。 login_start_time 否 String 登录应用开始时间，格式 2022-10-31 08:07:39。 login_end_time 否 String 登录应用结束时间，格式 2022-10-31 08:07:39。 virtual_ip 否 String 会话虚拟ip。