查询策略组中的策略项
功能介绍
查询指定策略组内的策略项。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/policy-groups/{policy_group_id}/policies
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id。 |
policy_group_id |
是 |
String |
策略组id。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
policy_type |
否 |
String |
根据策略类型过滤结果,不传则查询所有策略。 可选类型:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
发送的实体的MIME类型。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
policies |
Policies object |
策略类。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
虚拟通道。 |
watermark |
Watermark object |
水印。 |
keyboard_mouse |
keyboard_mouse object |
键盘鼠标。 |
seamless |
seamless object |
通用音视频旁路。 |
personalizedDataMgmt |
personalizedDataMgmt object |
个性化数据管理。 |
custom |
custom object |
自定义策略。 |
record_audit |
record_audit object |
录屏审计。 |
参数 |
参数类型 |
描述 |
---|---|---|
usb_custom_policy_debug |
String |
设备调试策略。 |
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 |
串口重定向。 |
parallel_port_redirection |
parallel_port_redirection object |
并口重定向。 |
driver_interface_redirection |
driver_interface_redirection object |
驱动接口重定向。 |
参数 |
参数类型 |
描述 |
---|---|---|
usb_enable |
Boolean |
是否开启USB端口重定向。 false:表示关闭。 true:表示开启。 |
options |
options object |
USB端口重定向控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 |
hid_redirection |
hid_redirection object |
HID(人体学设备)重定向。 |
参数 |
参数类型 |
描述 |
---|---|---|
printer_enable |
Boolean |
是否开启打印机设备重定向。取值为: false:表示关闭。 true:表示开启。 |
options |
options object |
打印机设备重定向控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
mobile_printer_enable |
Boolean |
移动客户端打印机重定向。取值为: false:表示关闭。 true:表示开启。 |
print_data_compression_mode |
Boolean |
是否开启打印数据压缩模式。取值为: false:表示关闭。 true:表示开启。 |
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
session_printer_enable |
Boolean |
是否开启会话打印机。取值为: false:表示关闭。 true:表示开启。 |
options |
options object |
会话打印机控制选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
video_compress_enable |
Boolean |
是否开启摄像头设备重定向。取值为: false:表示关闭。 true:表示开启。 |
options |
options object |
摄像头设备重定向控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
hid_redirection_enable |
Boolean |
是否开启HID(人体学设备)重定向。取值为: false:表示关闭。 true:表示开启。 |
options |
options object |
HID控制选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
pcsc_smart_card_enable |
String |
是否开启PC/SC智能卡重定向。取值为: Enable:表示已启动。 Closed:表示已关闭。 Disable:表示已禁用。 |
common_options |
common_options object |
USB和设备智能卡共同控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
remove_smart_card_disconnect_enable |
Boolean |
是否移除智能卡断开用户会话。取值为: false:表示关闭。 true:表示开启。 |
参数 |
参数类型 |
描述 |
---|---|---|
serial_port_enable |
Boolean |
是否开启串口重定向。取值为: false:表示关闭。 true:表示开启。 |
options |
options object |
串口重定向控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
parallel_port_enable |
Boolean |
是否开启并口重定向。取值为: false:表示关闭。 true:表示开启。 |
参数 |
参数类型 |
描述 |
---|---|---|
api_redir_driver_list |
String |
自定义驱动列表。(填写安装在终端的驱动文件名或驱动文件的全路径,支持配置多个,多个之间以";"隔开)。 |
参数 |
参数类型 |
描述 |
---|---|---|
audio_redirection_enable |
Boolean |
是否开启音频重定向。取值为: false:表示关闭。 true:表示开启。 |
play_volume |
String |
播音设置音量。 不设置音量取值为:Do Not Set Volume。 音量设置,最小值为10,最大值为100,中间取值,间隔为5的递增序列。如:10、15、20、25等。 |
play_volume_ratio |
String |
播音设置音量线性系数。取值为: 不设置:Do Not Set Volume Ratio。 低:Low。 中:Middle。 高:High。 |
record_volume |
String |
录音设置音量。 不设置取值为:Do Not Set Volume。 音量设置,最小值为10,最大值为100,中间取值,间隔为5的递增序列。如:10、15、20、25等。 |
record_volume_ratio |
String |
录音设置音量线性系数。取值为: 不设置:Do Not Set Volume Ratio。 低:Low。 中:Middle。 高:High。 |
audio_transmission_mode |
String |
音频传输方式。取值为: 可靠传输:Reliable Transmission。 实时传输:Real Time Transmission。 |
play_redirection_enable |
Boolean |
是否开启播音重定向。取值为: false:表示关闭。 true:表示开启。 |
play_classification |
String |
播音场景。取值为: 无损播音:LossLess。 语音通话:Speech Call。 音乐播音:Music Play。 自动识别:Automatic Identification。 |
play_quality |
String |
播音质量。取值为: 低:Low。 中:Middle。 高:High |
play_denoising |
String |
播音降噪。取值为: 不开启降噪:Disable Denoising。 开启降噪,最小值为-100,最大值为-5,中间取值,间隔为5的递增序列。如:-100、-95、-90、-85等。 |
play_agc |
String |
播音增益。取值为:不开启增益:Disable AGC。开启增益,最小值为4000,最大值为32000,中间取值,从10000开始间隔为1000的递增序列。如:4000、6000、8000、10000、11000、12000、13000等。 |
play_crc |
String |
播音设置冗余。取值为: 不开启冗余:Disable CRC。 开启冗余:Enable CRC。 |
play_device_mode |
String |
播音设置模式。取值为: 播音设备共享模式:Play Device In Shared Mode。 播音设备独占模式:Play Device In Exclusive Mode。 |
play_delay_threshold |
String |
播音控制时延阈值。取值为:最小值为160,最大值为2500。中间取值,400以下为40的递增序列,1000以下为50的递增序列。从高到低为:2500、2000、1800、1500、1200、1000、950、900、850等。 |
play_amplitude_threshold |
String |
播音检测振幅阈值。取值为:2048、4096、5120、6144、7168、8192。 |
play_prefill_data |
String |
播音音乐预充数据。取值为:不预充:Do Not Prefill Data。预充取值:最小值为50,最大值为2000,250以前为50的递增序列,500以前为100的递增序列。从高到低取值如:2000、1500、1000、500、400、300、250。 |
record_redirection_enable |
Boolean |
是否开启录音重定向。取值为: false:表示关闭。 true:表示开启。 |
record_classification |
String |
录音场景。取值为: 无损录音:LossLess。 语音通话:Speech Call。 音乐录音:Music Record。 自动识别:Automatic Identification。 |
record_quality |
String |
录音质量。取值为: 低:Low。 中:Middle。 高:High。 |
record_denoising |
String |
录音降噪。取值为: 不开启降噪:Disable Denoising。 开启降噪,最小值为-100,最大值为-5,中间取值,间隔为5的递增序列。如:-100、-95、-90、-85等。 |
record_agc |
String |
录音增益。取值为:不开启增益:Disable AGC。开启增益,最小值为4000,最大值为32000,中间取值,从10000开始间隔为1000的递增序列。如:4000、6000、8000、10000、11000、12000、13000等。 |
record_crc |
String |
录音设置冗余。取值为: 不开启冗余:Disable CRC。 开启冗余:Enable CRC。 |
record_device_mode |
String |
录音设置模式。取值为: 播音设备共享模式:Record Device In Shared Mode。 播音设备独占模式:Record Device In Exclusive Mode。 |
record_delay_threshold |
String |
录音控制时延阈值。取值为:最小值为160,最大值为2500。中间取值,400以下为40的递增序列,1000以下为50的递增序列。从高到低为:2500、2000、1800、1500、1200、1000、950、900、850等。 |
record_amplitude_threshold |
String |
录音检测振幅阈值。取值为:2048、4096、5120、6144、7168、8192。 |
参数 |
参数类型 |
描述 |
---|---|---|
automatic_reconnection_interval |
Integer |
自动重连间隔(秒)。取值范围为[1-50]。默认:5。 |
session_persistence_time |
Integer |
自动重连会话保持时长(秒)。取值范围为[0-180]。默认:180。 |
autoclose_monitor_after_locked |
Boolean |
锁屏后自动关闭本地显示器。取值为: false:表示关闭。 true:表示开启。 |
autoclose_monitor_options |
autoclose_monitor_options object |
自动关闭显示器控制的选项。 |
forbid_screen_capture |
Boolean |
防截屏策略开关。 false:表示关闭。 true:表示开启。 |
client_machine_join_domain |
Boolean |
终端机器加域校验开关。 false:表示关闭。 true:表示开启。 |
client_type |
client_type object |
终端类型登录管控。 |
参数 |
参数类型 |
描述 |
---|---|---|
autoclose_monitor_wait_time |
Integer |
自动关闭显示器等待时间。取值范围为[10-600000]。默认:300。 |
参数 |
参数类型 |
描述 |
---|---|---|
client_type_limit |
Boolean |
是否开启终端类型登录管控。 false:表示关闭。 true:表示开启。 |
options |
options object |
终端类型登录管控的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
sc_type_window |
Boolean |
是否勾选Windows客户端。取值为: false:表示未勾选。 true:表示勾选。 |
sc_type_mac |
Boolean |
是否勾选macOS客户端。取值为: false:表示未勾选。 true:表示勾选。 |
sc_type_android |
Boolean |
是否勾选Android客户端。取值为: false:表示未勾选。 true:表示勾选。 |
sc_type_linux |
Boolean |
是否勾选Linux客户端。取值为: false:表示未勾选。 true:表示勾选。 |
sc_type_h5 |
Boolean |
是否勾选Web客户端。取值为: false:表示未勾选。 true:表示勾选。 |
sc_type_ios |
Boolean |
是否勾选ios客户端。取值为: false:表示未勾选。 true:表示勾选。 |
sc_type_harmony_os |
Boolean |
是否勾选鸿蒙客户端。取值为: false:表示未勾选。 true:表示勾选。 |
tc_type_all |
Boolean |
是否勾选全部硬件终端。取值为: false:表示未勾选。 true:表示勾选。 |
参数 |
参数类型 |
描述 |
---|---|---|
display_level |
String |
显示级别。取值为: LEVEL1:表示等级1。 LEVEL2:表示等级2。 LEVEL3:表示等级3。 LEVEL4:表示等级4(默认/推荐)。 LEVEL5:表示等级5。 |
options |
options object |
显示级别共同控制的选项。 |
rendering_acceleration_enable |
Boolean |
是否开启渲染加速。取值为: false:表示关闭。 true:表示开启。 |
rendering_acceleration_options |
渲染加速控制选项。 |
|
adaptive_bitrate_control_enable |
Boolean |
是否开启自适应流控。取值为: false:表示关闭。 true:表示开启。 |
adaptive_bitrate_control_options |
自适应流控控制选项。 |
|
video_card_memory_size |
Integer |
显卡缓存(MB)。取值范围为[0-64]。默认:64。 |
configuration1_enable |
Boolean |
是否开启配置项1。取值为: false:表示关闭。 true:表示开启。 |
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:表示开启。 |
application_recognition |
String |
应用感知配置。 |
duplicate_display_enable |
Boolean |
同屏显示。取值为: false:表示关闭。 true:表示开启。 |
default_mapping_order |
String |
默认屏幕映射顺序。默认:1,2,3,4。 |
duplicate_display_mode |
String |
同屏显示模式。取值为: One-to-One:表示仅支持单路。 One-to-Many:表示支持多路。 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数 |
参数类型 |
描述 |
---|---|---|
average_video_bit_rate |
Integer |
视频平均码率(Kbps)。取值范围为[256-100000]。默认:18000。 |
参数 |
参数类型 |
描述 |
---|---|---|
average_video_quality |
Integer |
视频平均质量。取值范围为[5-59]。默认:15。 |
lowest_video_quality |
Integer |
视频最低质量。取值范围为[5-69]。默认:25。 |
highest_video_quality |
Integer |
视频最高质量。取值范围为[1-59]。默认:7。 |
参数 |
参数类型 |
描述 |
---|---|---|
video_acceleration_enhancement_enable |
Boolean |
视频加速增强配置。取值为: false:表示关闭。 true:表示开启。 |
video_optimization_enable |
Boolean |
是否开启视频场景优化。取值为: false:表示关闭。 true:表示开启。 |
gpu_color_optimization_enable |
Boolean |
是否开启GPU色彩优化。取值为: false:表示关闭。 true:表示开启。 |
video_recognition_threshold |
Integer |
视频识别阈值。取值范围为[0-500]。默认:10。 |
frame_rate_statistical_length |
Integer |
帧率统计长度。取值范围为[2-100]。默认:4。 |
image_quality_threshold |
Integer |
图像质量阈值。取值范围为[0-100]。默认:0。 |
refresh_frequency_threshold |
Integer |
刷新率阈值。取值范围为[1-100]。默认:3。 |
exiting_video_area_threshold |
Integer |
退出视频区域阈值。取值范围为[0-100]。默认:8。 |
min_video_width |
Integer |
识别为视频的最小宽。取值范围为[0-1280]。默认:191。 |
min_video_length |
Integer |
识别为视频的最小高。取值范围为[0-1280]。默认:191。 |
single_frame_natural_percentage |
String |
单帧自然图像块占比阈值。取值范围为[0.000001-1]。默认:0.3。 |
cyclical_natural_images_number |
Integer |
周期自然图像数目占比阈值。取值范围为[0-100]。默认:2。 |
non_natural_image_percentage |
String |
非自然图面积占比阈值。取值范围为[0.000001-1]。默认:0.85。 |
non_natural_images_number |
Integer |
非自然图数目占比阈值。取值范围为[0-100]。默认:25。 |
参数 |
参数类型 |
描述 |
---|---|---|
peak_bandwidth_suppression_enable |
Boolean |
峰值带宽抑制:取值为: false:表示关闭。 true:表示开启。 |
expected_average_network_latency |
Integer |
网络平均期望延时。取值范围为[1-2000]。默认:160。 |
network_latency_threshold1 |
Integer |
网络延时阈值1(ms)。取值范围为[1-2000]。默认:160。 |
network_latency_threshold2 |
Integer |
网络延时阈值2(ms)。取值范围为[1-2000]。默认:300。 |
min_dynamic_frame_rate |
Integer |
最小动态帧率(fps)。取值范围为[1-60]。默认:17。 |
min_dynamic_frame_rate_lv1 |
Integer |
最小动态帧率Lv1(fps)。取值范围为[1-60]。默认:17。 |
min_dynamic_frame_rate_lv2 |
Integer |
最小动态帧率Lv2(fps)。取值范围为[1-60]。默认:10。 |
rtt_threshold |
Integer |
帧率控制参数1。取值范围为[0-1000]。默认:20。 |
min_add_framerate |
Integer |
帧率控制参数2。取值范围为[0-120]。默认:8。 |
max_add_framerate |
Integer |
帧率控制参数3。取值范围为[0-120]。默认:20。 |
sub_framerate |
Integer |
帧率控制参数4。取值范围为[0-120]。默认:25。 |
adaptive_bandwidth_lower_limit |
Integer |
自适应带宽下限。取值范围为[100-20000]。默认:500。 |
adaptive_compression_quality_lower_limit |
Integer |
自适应有损压缩质量下限。取值范围为[1-100]。默认:60。 |
adaptive_compression_quality_upper_limit |
Integer |
自适应有损压缩质量上限。取值范围为[1-100]。默认:85。 |
adaptive_compression_quality_increase_limit |
Integer |
自适应有损压缩质量增限。取值范围为[1-100]。默认:5。 |
adaptive_compression_quality_decrease_limit |
Integer |
自适应有损压缩质量减限。取值范围为[1-100]。默认:10。 |
adaptive_average_quality_lower_limit |
Integer |
自适应视频平均质量下限。取值范围为[5-50]。默认:15。 |
adaptive_average_quality_upper_limit |
Integer |
自适应视频平均质量上限。取值范围为[5-50]。默认:25。 |
adaptive_average_quality_increase_limit |
Integer |
自适应视频平均质量增限。取值范围为[1-50]。默认:3。 |
adaptive_average_quality_decrease_limit |
Integer |
自适应视频平均质量减限。取值范围为[1-50]。默认:1。 |
adaptive_min_quality_lower_limit |
Integer |
自适应视频最低质量下限。取值范围为[5-69]。默认:25。 |
adaptive_min_quality_upper_limit |
Integer |
自适应视频最低质量上限。取值范围为[5-69]。默认:30。 |
adaptive_min_quality_increase_limit |
Integer |
自适应视频最低质量增限。取值范围为[1-50]。默认:3。 |
adaptive_min_quality_decrease_limit |
Integer |
自适应视频最低质量减限。取值范围为[1-50]。默认:1。 |
参数 |
参数类型 |
描述 |
---|---|---|
file_redirection |
file_redirection object |
文件重定向。 |
clip_length_limit_flag_c2s |
Boolean |
剪切板长度表示。 |
clip_length_limit_c2s |
Integer |
剪切板客户端长度。 |
clip_length_limit_flag_s2c |
Boolean |
剪切板长度表示。 |
clip_length_limit_s2c |
Integer |
剪切板客户端长度。 |
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 |
剪切板重定向控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
redirection_mode |
String |
文件重定向。取值为: DISABLED:表示禁用。(默认) READ_ONLY:表示只读。 READ_AND_WRITE:表示读写。 |
options |
options object |
文件重定向控制的选项。 |
vm_send_file_client |
Boolean |
是否开启发送文件(虚机到客户端)。取值为: false:表示关闭。 true:表示开启。 |
redirection_send_file_options |
重定向和发送文件共同控制项。 |
参数 |
参数类型 |
描述 |
---|---|---|
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支持设置文件大小控制项。 |
|
linux_root_mount_switch_enable |
Boolean |
是否开启Linux根目录挂载开关。取值为: false:表示关闭。 true:表示开启。 |
linux_root_dir_list |
String |
Linux根目录挂载路径。默认:"\var\log"。 |
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|lifs"。 |
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:表示开启。 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
compression_threshold |
Integer |
压缩阈值(Byte)。取值范围为[0-10240]。默认:512。 |
minimum_compression_rate |
Integer |
最小压缩率。取值范围为[0-1000]。默认:900。 |
参数 |
参数类型 |
描述 |
---|---|---|
linux_file_size_supported_threshold |
Integer |
Linux设置文件大小阈值(Byte)。取值范围为[0-4096]。默认:100。 |
参数 |
参数类型 |
描述 |
---|---|---|
read_write_speed |
Integer |
读写速度(Kbps)。取值范围为[0-2147483647]。默认:0。 |
参数 |
参数类型 |
描述 |
---|---|---|
rich_text_redirection_enable |
Boolean |
是否开启剪切板富文本重定向。取值为: false:表示关闭。 true:表示开启。 |
clipboard_file_redirection_enable |
Boolean |
是否开启剪切板文件重定向。取值为: false:表示关闭。 true:表示开启。 |
参数 |
参数类型 |
描述 |
---|---|---|
vdi |
Vdi object |
VDI。 |
self_help_console |
Boolean |
是否开启自助维护台抢占登陆。取值为:false:表示关闭。true:表示开启。 |
disconnect_on_lock_flag |
Boolean |
是否锁屏后断开。 |
参数 |
参数类型 |
描述 |
---|---|---|
auto_lock_enable |
Boolean |
是否开启自动锁屏。取值为:false:表示关闭。true:表示开启。 |
auto_lock_options |
AutoLockOptions object |
自动锁屏开启后可控制的选项。 |
disconnect_logout_enable |
Integer |
是否开启断开后自动注销。取值为:0:表示关闭。1:表示开启。 |
disconnect_logout_options |
DisconnectLogoutOptions object |
开启断开后自动注销后可控制的选项。 |
disconnect_hibernate_enable |
Boolean |
是否开启断开后自动注销。取值为:0:表示关闭。1:表示开启。 |
disconnect_hibernate_options |
disconnect_hibernate_options object |
休眠断开选项。 |
no_operation_hibernate_enable |
Boolean |
是否开启断开后自动注销。取值为:0:表示关闭。1:表示开启。 |
no_operation_hibernate_options |
不操作休眠选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
auto_lock_minutes |
Integer |
锁屏等待时间(分钟)。取值范围为[3-86400]。默认:10。 |
auto_disconnect |
String |
自动断开或注销。取值为:AUTO_DISCONNECT:自动断开。AUTO_LOGOUT:自动注销。DISABLED:已禁用。(默认)AUTO_RESTART:自动重启。AUTO_STOP:自动停止。HIBERNATE:休眠。 |
options |
开启自动断开或自动注销后的控制项。 |
参数 |
参数类型 |
描述 |
---|---|---|
auto_disconnect_minutes |
Integer |
断开或注销等待时间(分钟)。取值范围为[1-86400]。默认:1440。 |
参数 |
参数类型 |
描述 |
---|---|---|
disconnect_logout_minutes |
Integer |
断开后自动注销等待时间(分钟)。取值范围为[3-86400]。默认:10。 |
参数 |
参数类型 |
描述 |
---|---|---|
virtual_channel_control_enable |
Boolean |
是否开启虚拟通道策略设置。取值为:false:表示关闭。true:表示开启。 |
options |
VirtualChannelOptions object |
虚拟通道策略控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
custom_virtual_channel_name |
String |
自定义虚拟通道注册名。目前仅支持ASCII码字符。 |
virtual_channel_plugin_details |
String |
虚拟通道下载配置信息,需Base64加密。加密前目前仅支持ASCII码字符。 |
third_party_plugin_name |
String |
第三方插件名称。 |
参数 |
参数类型 |
描述 |
---|---|---|
watermark_enable |
Boolean |
是否开启水印策略设置。取值为:false:表示关闭。true:表示开启。 |
options |
WatermarkOptions object |
水印策略控制的选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
show_style |
String |
展示方式。取值为:FIXED:固定位置。RANDOM:随机运动。 |
color |
String |
颜色。格式:RRGGBB。默认:2a2a2a。 |
font_size |
Integer |
字体大小。取值范围为[1-200]。默认:30。 |
opacity_setting |
String |
不透明度(%)。取值范围为[0-100]。默认:"12.5"。 |
content_item_count |
Integer |
条目数量。取值范围为[1-30]。默认:1。 |
display_format |
String |
水印内容显示格式。 |
lean |
Integer |
倾斜度。取值范围为[-90-90]。默认:-45。 |
content_customized |
String |
自定义内容。内容不得带有类似'>'的特殊字符。 |
content_color |
String |
内容颜色。 |
watermark_security_access |
Boolean |
安全优先开关。 |
user_extend_info_switch |
Boolean |
用户扩展信息开关。false:表示关闭。true:表示开启。 |
user_extend_info |
String |
用户扩展信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
mouse_feedback |
String |
虚拟机鼠标回馈。取值为: SELFADAPTION:自适应鼠标回馈。 FORCE:强制鼠标回馈。 CLOSE:关闭鼠标回馈。 |
mouse_simulation_mode |
String |
虚拟机鼠标模拟方式。取值为: ABSOLUTE_POSITION:绝对位置模拟。 RELATIVE_POSITION:相对位置模拟。 |
external_cursor_feedback |
Boolean |
虚拟机外部光标反馈。取值为: false:表示关闭。 true:表示开启。 |
selfhelp_console_enable |
Boolean |
自助维护台抢占登陆。取值为: false:表示关闭。 true:表示开启。 |
client_mouse_send_interval |
Integer |
客户端鼠标发送间隔。取值范围为[1-30]。默认:30。 |
windows_client_keyboard_mode |
String |
Windows客户端键盘模式。取值为: GLOBAL:Windows客户端键盘全局模式。(默认) WINDOW:Windows客户端键盘窗口模式。 |
windows_client_mouse_mode |
String |
Windows客户端鼠标模式。取值为: GLOBAL:Windows客户端鼠标全局模式。 WINDOW:Windows客户端鼠标窗口模式。(默认) |
linux_client_keyboard_mode |
String |
Linux客户端键盘模式。取值为: EVENT:Linux客户端键盘事件模式。(默认) GRAPH:Linux客户端键盘图形模式。 |
linux_client_mouse_mode |
String |
Linux客户端鼠标模式。取值为: EVENT:Linux客户端鼠标事件模式。(默认) GRAPH:Linux客户端鼠标窗口模式。 |
special_keyboard |
Boolean |
特殊键盘。取值为: false:表示关闭。 true:表示开启。 |
joy_stick_flag |
Boolean |
游戏操纵杆。取值为: false:表示关闭。 true:表示开启。 |
参数 |
参数类型 |
描述 |
---|---|---|
seamless_enable |
Boolean |
是否开启通用音视频开关。取值为: false:表示关闭。 true:表示开启。 |
options |
options object |
通用音视频设置项。 |
参数 |
参数类型 |
描述 |
---|---|---|
personalized_data_mgmt_path |
String |
个性化数据管理路径。 |
user_data_roaming_enable |
Boolean |
用户数据漫游。 |
user_data_roaming_options |
user_data_roaming_options object |
用户数据漫游选项。 |
user_folder_redirection_enable |
Boolean |
启用用户文件夹重定向。 |
user_folder_redirection_options |
用户文件夹重定向选项。 |
|
logoff_delete_user_configuration |
Boolean |
启用用户文件夹重定向。 |
network_drive_mapping_enable |
Boolean |
启用用户文件夹重定向。 |
network_drive_mapping_options |
网络驱动器映射选项。 |
参数 |
参数类型 |
描述 |
---|---|---|
profile_streaming_enable |
Boolean |
配置文件流式处理启用。 |
roamed_files_local_path |
String |
漫游文件本地路径。 |
exclude_folders_path |
String |
排除文件夹路径。 |
roaming_registry_method |
String |
排除文件夹路径。 |
roaming_registry_path |
String |
漫游注册路径。 |
参数 |
参数类型 |
描述 |
---|---|---|
restore_local_directories_enable |
Boolean |
还原本地目录启用。 |
appData_roaming_enale |
Boolean |
应用数据漫游启用。 |
redirec_desktop |
Boolean |
桌面重定向。 |
redirec_start_menu |
Boolean |
开始菜单。 |
redirec_documents |
Boolean |
文档。 |
redirec_pictures |
Boolean |
照片。 |
redirec_music |
Boolean |
音乐。 |
redirec_videos |
Boolean |
录音。 |
redirec_favorites |
Boolean |
最爱。 |
redirec_contacts |
Boolean |
录音。 |
redirec_downloads |
Boolean |
下载。 |
redirec_links |
Boolean |
链接。 |
redirec_searches |
Boolean |
查找。 |
redirec_saved_games |
Boolean |
游戏存储。 |
参数 |
参数类型 |
描述 |
---|---|---|
network_drive_mapping_path |
String |
网络驱动器映射路径。 |
drive_letter |
String |
排除文件夹路径。 |
参数 |
参数类型 |
描述 |
---|---|---|
custom_configuration1_enable |
Boolean |
自定义配置启用。 |
options |
options object |
通用音视频设置项。 |
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
是否开启录屏审计。取值为: false:表示关闭。 true:表示开启。 |
rules |
rules object |
录屏规则列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
record_type |
String |
录制类型。取值为: whole:表示全程录屏。 interval:表示间隔录屏。 userOperations:表示用户操作录屏。 sessionMonitoring:监听会话生命周期录屏。 |
interval_record_start_time |
String |
间隔录制开始时间,仅录制类型为interval时有效。 |
interval_record_end_time |
String |
间隔录制结束时间,仅录制类型为interval时有效。 |
op_type |
String |
操作触发类型,仅录制类型为userOperations时有效。取值为: input:表示用户输入内容即启动录屏。 filecopy:表示用户拷贝文件即启动录屏。 |
audio_record |
Boolean |
是否开启音频录制开关。取值为: false:表示关闭。 true:表示开启。 |
fps |
Integer |
录制帧率。取值为:2/5/10/15。 |
duration |
Integer |
录制视频单文件时长(分钟)。取值为:10/20/30/60。 |
resolution |
String |
分辨率设置。取值为:720P/1080P/original。 |
retention_duration |
Integer |
录屏文件保留时长(天)。取值为1~180天,0 表示永久保留。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 405
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 503
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
GET /v2/089b2f9a3d80d3062f24c00ca4ed5cbd/policy-groups/8ac225c277ceab6d0177cf829bd6008b/policies?policy_type=SessionAutoDisconnect
响应示例
状态码: 200
查询策略组中的策略项的响应。
{ "policies" : { "session" : { "vdi" : { "auto_lock_enable" : true, "auto_lock_options" : { "auto_lock_minutes" : 10, "auto_disconnect" : "DISABLED", "options" : { "auto_disconnect_minutes" : 1440 } }, "disconnect_logout_enable" : 0, "disconnect_logout_options" : { "disconnect_logout_minutes" : 10 } }, "self_help_console" : true } } }
状态码
状态码 |
描述 |
---|---|
200 |
查询策略组中的策略项的响应。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
405 |
请求中指定的方法不被允许。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
503 |
服务不可用。 |
错误码
请参见错误码。