更新时间:2024-09-05 GMT+08:00
分享

新增策略模板

功能介绍

新增策略模板。策略模板创建好后,用户在创建策略组的时候,就可以根据已有策略模板按需调整配置,快速完成策略组的创建。

调试

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

URI

POST /v1/{project_id}/policy-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

policy_group

PolicyTemplate object

策略模板。

表4 PolicyTemplate

参数

是否必选

参数类型

描述

policy_group_name

String

策略组名称,名称需要满足如下规则:

  1. 不能有空格和.开头,可以由中文、数字、英文大小写组成。

  2. 字符长度范围1-55。

description

String

描述。

policies

Policies object

策略。

表5 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

自定义策略

表6 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

串口重定向。

表7 usb_port_redirection

参数

是否必选

参数类型

描述

usb_enable

Boolean

是否开启USB端口重定向。取值为:

  • false:表示关闭。

  • true:表示开启。

options

UsbPortRedirectionOptions object

USB端口重定向控制的选项。

表8 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:通用模式。

表9 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。

表10 printer_redirection

参数

是否必选

参数类型

描述

printer_enable

Boolean

是否开启打印机设备重定向。取值为:

  • false:表示关闭。

  • true:表示开启。

options

PrinterRedirectionOptions object

打印机设备重定向控制的选项。

表11 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。

表12 session_printer

参数

是否必选

参数类型

描述

session_printer_enable

Boolean

是否开启会话打印机。取值为: false:表示关闭。 true:表示开启。

options

SessionPrinterOptions object

会话打印机控制选项。

表13 SessionPrinterOptions

参数

是否必选

参数类型

描述

session_printer_customization_policy

String

会话打印机自定义策略。

表14 camera_redirection

参数

是否必选

参数类型

描述

video_compress_enable

Boolean

是否开启摄像头设备重定向。取值为: false:表示关闭。 true:表示开启。

options

CameraRedirectionOptions object

摄像头设备重定向控制的选项。

表15 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。

表16 usb_device_common

参数

是否必选

参数类型

描述

pcsc_smart_card_enable

String

是否开启PC/SC智能卡重定向。取值为: Enable:表示已启动。 Closed:表示已关闭。 Disable:表示已禁用。

common_options

common_options object

USB和设备智能卡共同控制的选项。

表17 common_options

参数

是否必选

参数类型

描述

remove_smart_card_disconnect_enable

Boolean

是否移除智能卡断开用户会话。取值为: false:表示关闭。 true:表示开启。

表18 serial_port_redirection

参数

是否必选

参数类型

描述

serial_port_enable

Boolean

是否开启串口重定向。取值为: false:表示关闭。 true:表示开启。

options

SerialPortRedirectionOptions object

串口重定向控制的选项。

表19 SerialPortRedirectionOptions

参数

是否必选

参数类型

描述

auto_connect_enable

Boolean

是否自动连接客户端串口。取值为: false:表示关闭。 true:表示开启。

表20 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。

表21 client

参数

是否必选

参数类型

描述

automatic_reconnection_interval

Integer

自动重连间隔(秒)。取值范围为[1-50]。默认:5。

session_persistence_time

Integer

自动重连会话保持时长(秒)。取值范围为[0-180]。默认:180。

forbid_screen_capture

Boolean

防截屏策略开关。 false:表示关闭。 true:表示开启。

表22 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:表示开启。

表23 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。

表24 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

表25 video_bit_rate_options

参数

是否必选

参数类型

描述

average_video_bit_rate

Integer

视频平均码率(Kbps)。取值范围为[256-100000]。默认:18000。

表26 video_quality_options

参数

是否必选

参数类型

描述

average_video_quality

Integer

视频平均质量。取值范围为[5-59]。默认:15。

lowest_video_quality

Integer

视频最低质量。取值范围为[5-69]。默认:25。

highest_video_quality

Integer

视频最高质量。取值范围为[1-59]。默认:7。

表27 rendering_acceleration_options

参数

是否必选

参数类型

描述

video_acceleration_enhancement_enable

Boolean

视频加速增强配置。取值为: false:表示关闭。 true:表示开启。

video_optimization_enable

Boolean

是否开启视频场景优化。取值为: false:表示关闭。 true:表示开启。

gpu_color_optimization_enable

Boolean

是否开启GPU色彩优化。取值为: false:表示关闭。 true:表示开启。

表28 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

剪切板重定向控制的选项。

表29 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

重定向和发送文件共同控制项。

表30 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:表示开启。

表31 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。

表32 compression_switch_options

参数

是否必选

参数类型

描述

compression_threshold

Integer

压缩阈值(Byte)。取值范围为[0-10240]。默认:512。

minimum_compression_rate

Integer

最小压缩率。取值范围为[0-1000]。默认:900。

表33 linux_file_size_supported_options

参数

是否必选

参数类型

描述

linux_file_size_supported_threshold

Integer

Linux设置文件大小阈值(Byte)。取值范围为[0-4096]。默认:100。

表34 redirection_send_file_options

参数

是否必选

参数类型

描述

read_write_speed

Integer

读写速度(Kbps)。取值范围为[0-2147483647]。默认:0。

表35 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

虚拟机到本地长度限制。

表36 Session

参数

是否必选

参数类型

描述

sbc

Sbc object

SBC结构体。

表37 Sbc

参数

是否必选

参数类型

描述

sbc_automatic_disconnection

String

连接策略:

  • DISABLED:已禁用

  • AUTO_DISCONNECT:自动断开

  • AUTO_LOCK:自动锁屏

sbc_automatic_disconnection_options

SbcAutomaticDisconnectionOptions object

自动连接选项。

表38 SbcAutomaticDisconnectionOptions

参数

是否必选

参数类型

描述

disconnection_waiting_time

Integer

等待时间(分钟)。

sbc_auto_logout

Boolean

是否自动注销。取值为:false:表示是。true:表示否。

auto_logout_options

AutoLogoutOptions object

自动注销。

表39 AutoLogoutOptions

参数

是否必选

参数类型

描述

sbc_logout_waiting_time

Integer

会话断连保留时长(分钟)。

表40 VirtualChannel

参数

是否必选

参数类型

描述

virtual_channel_control_enable

Boolean

是否开启虚拟通道策略设置。取值为:false:表示关闭。true:表示开启。

options

VirtualChannelOptions object

虚拟通道策略控制的选项。

表41 VirtualChannelOptions

参数

是否必选

参数类型

描述

custom_virtual_channel_name

String

自定义虚拟通道注册名。

virtual_channel_plugin_details

String

虚拟通道下载配置信息,需Base64加密。

third_party_plugin_name

String

第三方插件名称。

表42 keyboard_mouse

参数

是否必选

参数类型

描述

mouse_feedback

String

虚拟机鼠标回馈。取值为: SELFADAPTION:自适应鼠标回馈。 FORCE:强制鼠标回馈。 CLOSE:关闭鼠标回馈。

mouse_simulation_mode

String

虚拟机鼠标模拟方式。取值为: ABSOLUTE_POSITION:绝对位置模拟。 RELATIVE_POSITION:相对位置模拟。

external_cursor_feedback

Boolean

虚拟机外部光标反馈。取值为: false:表示关闭。 true:表示开启。

表43 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

虚拟通道带宽控制的选项。

表44 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

虚拟通道带宽百分比控制的选项。

表45 DisplayBandwidthPercentageOptions

参数

是否必选

参数类型

描述

display_bandwidth_percentage_value

Integer

显示带宽百分比控制量(%)。取值范围为[0-100]。默认:65。

表46 MultimediaBandwidthPercentageOptions

参数

是否必选

参数类型

描述

multimedia_bandwidth_percentage_value

Integer

多媒体带宽百分比控制量(%)。取值范围为[0-100]。默认:50。

表47 UsbBandwidthPercentageOptions

参数

是否必选

参数类型

描述

usb_bandwidth_percentage_value

Integer

USB带宽百分比控制量(%)。取值范围为[0-100]。默认:100。

表48 PcscBandwidthPercentageOptions

参数

是否必选

参数类型

描述

pcsc_bandwidth_percentage_value

Integer

PCSC带宽百分比控制量(%)。取值范围为[0-100]。默认:5。

表49 TwainBandwidthPercentageOptions

参数

是否必选

参数类型

描述

twain_bandwidth_percentage_value

Integer

TWAIN带宽百分比控制量(%)。取值范围为[0-100]。默认:15。

表50 PrinterBandwidthPercentageOptions

参数

是否必选

参数类型

描述

printer_bandwidth_percentage_value

Integer

打印机带宽百分比控制量(%)。取值范围为[0-100]。默认:5。

表51 ComBandwidthPercentageOptions

参数

是否必选

参数类型

描述

com_bandwidth_percentage_value

Integer

串口带宽百分比控制量(%)。取值范围为[0-100]。默认:3。

表52 FileRedirectionBandwidthPercentageOptions

参数

是否必选

参数类型

描述

file_redirection_bandwidth_percentage_value

Integer

文件重定向带宽百分比控制量(%)。取值范围为[0-100]。默认:30。

表53 ClipboardBandwidthPercentageOptions

参数

是否必选

参数类型

描述

clipboard_bandwidth_percentage_value

Integer

剪切板带宽百分比控制量(%)。取值范围为[0-100]。默认:3。

表54 SecureChannelBandwidthPercentageOptions

参数

是否必选

参数类型

描述

secure_channel_bandwidth_percentage_value

Integer

安全通道带宽百分比控制量(%)。取值范围为[0-100]。默认:30。

表55 CameraBandwidthPercentageOptions

参数

是否必选

参数类型

描述

camera_bandwidth_percentage_value

Integer

摄像头带宽百分比控制量(%)。取值范围为[0-100]。默认:30。

表56 VirtualChannelBandwidthPercentageOptions

参数

是否必选

参数类型

描述

virtual_channel_bandwidth_percentage_value

Integer

虚拟通道带宽百分比控制量(%)。取值范围为[0-100]。默认:65。

表57 DisplayBandwidthControlOptions

参数

是否必选

参数类型

描述

display_bandwidth_control_value

Integer

显示带宽控制量(Kbps)。取值范围为[500-50000]。默认:20000。

表58 MultimediaBandwidthControlOptions

参数

是否必选

参数类型

描述

multimedia_bandwidth_control_value

Integer

多媒体带宽控制量(Kbps)。取值范围为[5000-20000]。默认:15000。

表59 UsbBandwidthControlOptions

参数

是否必选

参数类型

描述

usb_bandwidth_control_value

Integer

USB带宽控制量(Kbps)。取值范围为[1000-30000]。默认:30000。

表60 PcscBandwidthControlOptions

参数

是否必选

参数类型

描述

pcsc_bandwidth_control_value

Integer

PCSC带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。

表61 TwainBandwidthControlOptions

参数

是否必选

参数类型

描述

twain_bandwidth_control_value

Integer

TWAIN带宽控制量(Kbps)。取值范围为[2000-10000]。默认:5000。

表62 PrinterBandwidthControlOptions

参数

是否必选

参数类型

描述

printer_bandwidth_control_value

Integer

打印机带宽控制量(Kbps)。取值范围为[1000-5000]。默认:2000。

表63 ComBandwidthControlOptions

参数

是否必选

参数类型

描述

com_bandwidth_control_value

Integer

串口带宽控制量(Kbps)。取值范围为[500-2000]。默认:1000。

表64 FileRedirectionBandwidthControlOptions

参数

是否必选

参数类型

描述

file_redirection_bandwidth_control_value

Integer

文件重定向带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。

表65 ClipboardBandwidthControlOptions

参数

是否必选

参数类型

描述

clipboard_bandwidth_control_value

Integer

剪切板带宽控制量(Kbps)。取值范围为[100-2000]。默认:1000。

表66 SecureChannelBandwidthControlOptions

参数

是否必选

参数类型

描述

secure_channel_bandwidth_control_value

Integer

安全通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:10000。

表67 CameraBandwidthControlOptions

参数

是否必选

参数类型

描述

camera_bandwidth_control_value

Integer

摄像头带宽控制量(Kbps)。取值范围为[0-10000]。默认:10000。

表68 VirtualChannelBandwidthControlOptions

参数

是否必选

参数类型

描述

virtual_channel_bandwidth_control_value

Integer

虚拟通道带宽控制量(Kbps)。取值范围为[500-20000]。默认:20000。

表69 custom

参数

是否必选

参数类型

描述

custom_configuration1_enable

Boolean

自定义策略配置项1: false: 表示关闭 true: 表示开启

options

CustomOptions object

自定义策略设置项。

表70 CustomOptions

参数

是否必选

参数类型

描述

custom_configuration1_rule

String

配置项1内容。

响应参数

状态码: 200

表71 响应Body参数

参数

参数类型

描述

id

String

策略组ID。

状态码: 400

表72 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表73 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表74 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表75 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表76 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表77 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表78 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

POST /v1/29dfe82ada564ac2b927e1ff036d9a9b/policy-templates

{
  "policy_group" : {
    "policy_group_name" : "policy_group_name1926076252",
    "policies" : {
      "peripherals" : {
        "device_redirection" : {
          "session_printer" : {
            "session_printer_enable" : false,
            "options" : {
              "session_printer_customization_policy" : ""
            }
          },
          "printer_redirection" : {
            "options" : {
              "universal_printer_driver" : "Default",
              "sync_client_default_printer_enable" : true
            },
            "printer_enable" : true
          }
        }
      },
      "session" : {
        "sbc" : {
          "sbc_automatic_disconnection" : "DISABLED",
          "sbc_automatic_disconnection_options" : {
            "auto_logout_options" : {
              "sbc_logout_waiting_time" : 1440
            },
            "sbc_auto_logout" : false,
            "disconnection_waiting_time" : 10
          }
        }
      },
      "display" : {
        "change_resolution_vm" : false,
        "video_card_memory_size" : 64,
        "driver_delegation_mode_enable" : false,
        "options" : {
          "color_enhancement_enable" : false,
          "encoding_preset" : "Preset 1",
          "smoothing_factor" : 60,
          "video_quality_options" : {
            "lowest_video_quality" : 25,
            "highest_video_quality" : 7,
            "average_video_quality" : 15
          },
          "peak_video_bit_rate" : 18000,
          "gop_size" : 100,
          "video_frame_rate" : 30,
          "lossy_compression_quality" : 85,
          "video_bit_rate_options" : {
            "average_video_bit_rate" : 18000
          },
          "deep_compression_options" : {
            "deep_compression_level" : "Compression grade 0"
          },
          "quality_bandwidth_first" : "Quality First",
          "lossless_compression_mode" : "Basic Compression",
          "frame_rate" : 25,
          "display_bandwidth" : 20000,
          "min_image_cache" : 200
        },
        "driver_delegation_latency" : 80,
        "video_latency" : 80,
        "display_level" : "LEVEL4"
      },
      "client" : {
        "automatic_reconnection_interval" : 5,
        "session_persistence_time" : 180
      },
      "virtual_channel" : {
        "options" : {
          "custom_virtual_channel_name" : "",
          "virtual_channel_plugin_details" : "",
          "third_party_plugin_name" : ""
        },
        "virtual_channel_control_enable" : false
      },
      "keyboard_mouse" : {
        "mouse_simulation_mode" : "ABSOLUTE_POSITION",
        "external_cursor_feedback" : false,
        "mouse_feedback" : "SELFADAPTION"
      },
      "file_and_clipboard" : {
        "file_redirection" : {
          "redirection_mode" : "DISABLED",
          "redirection_send_file_options" : {
            "read_write_speed" : 0
          },
          "options" : {
            "fixed_drive_enable" : true,
            "fluid_control_switch_enable" : false,
            "compression_switch_options" : {
              "compression_threshold" : 512,
              "minimum_compression_rate" : 900
            },
            "removable_drive_enable" : true,
            "linux_fixed_drive_file_system_format" : "",
            "compression_switch_enable" : false,
            "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir",
            "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf",
            "linux_root_mount_switch_enable" : true,
            "path_separator" : "|",
            "network_drive_enable" : true,
            "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media",
            "linux_root_dir_list" : "\\\\var\\\\log",
            "cd_rom_drive_enable" : true,
            "fluid_control_options" : {
              "poor_network_latency" : 100,
              "reducing_step" : 20,
              "test_time_gap" : 10000,
              "test_block_size" : 64,
              "start_speed" : 1024,
              "normal_network_latency" : 70,
              "slow_increasing_step" : 10,
              "good_network_latency" : 30,
              "quick_increasing_step" : 20
            },
            "linux_file_size_supported_enable" : true,
            "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs",
            "linux_file_size_supported_options" : {
              "linux_file_size_supported_threshold" : 100
            }
          },
          "vm_send_file_client" : false
        },
        "clipboard_redirection" : "DISABLED",
        "clipboard_redirection_options" : {
          "rich_text_redirection_enable" : true,
          "file_clipboard_redirection" : "DISABLED",
          "rich_text_clipboard_redirection" : "DISABLED",
          "clipboard_file_redirection_enable" : true
        },
        "fd_mobile_client_redir_enable" : true
      },
      "audio" : {
        "record_classification" : "Speech Call",
        "play_redirection_enable" : true,
        "play_classification" : "Music Play",
        "record_redirection_enable" : true,
        "audio_redirection_enable" : true
      }
    },
    "description" : "策略组description1713560713"
  }
}

响应示例

状态码: 200

创建策略模板响应。

{
  "id" : "8885bcc45d547b41015d547d227e0000"
}

状态码

状态码

描述

200

创建策略模板响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码

相关文档