El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
DataArts Fabric
IoT
IoT Device Access
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
Huawei Cloud Astro Canvas
Huawei Cloud Astro Zero
CodeArts Governance
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance (CCI)
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Cloud Transformation
Well-Architected Framework
Cloud Adoption Framework
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Blockchain
Blockchain Service
Web3 Node Engine Service
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Adding a Policy Group

Updated on 2025-07-14 GMT+08:00

Function

Adds a policy group.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/policy-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

MIME type of the request body, for example, application/json.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

policy_group

Yes

PolicyGroupForCreate object

Policy group information.

Table 4 PolicyGroupForCreate

Parameter

Mandatory

Type

Description

policy_group_id

No

String

Policy group ID.

policy_group_name

No

String

Policy group name, which contains a maximum of 255 characters, including digits, letters, and underscores (_).

priority

No

Integer

Priority.

description

No

String

Policy group description, which contains a maximum of 255 characters.

update_time

No

String

Update time.

targets

No

Array of Target objects

Objects to which a policy applies.

policies

No

Policies object

Policy.

Table 5 Target

Parameter

Mandatory

Type

Description

target_id

No

String

Object ID.

target_name

No

String

Object name. The value can contain a maximum of 55 characters.

target_type

No

String

Object type.

  • INSTANCE: desktops

  • target_id: desktop SIDs

  • target_name: desktop names

  • USER: users

  • target_id: user IDs

  • target_name: usernames

  • USERGROUP: user groups

  • target_id: user group IDs

  • target_name: user group names

  • CLIENTIP: terminal IP addresses

  • target_id: terminal IP addresses

  • target_name: terminal IP addresses

  • OU: organization units

  • target_id: OU IDs

  • target_name: OU names

  • DESKTOPSPOOL: desktop pools

  • target_id: desktop pool IDs

  • target_name: desktop pool names

  • ALL: all desktops

  • target_id: default-apply-all-targets

  • target_name: All-Targets

Table 6 Policies

Parameter

Mandatory

Type

Description

peripherals

No

peripherals object

Peripheral.

audio

No

audio object

Audio.

client

No

client object

Client.

display

No

display object

Display.

file_and_clipboard

No

file_and_clipboard object

Files and clipboards.

session

No

Session object

Sessions.

virtual_channel

No

VirtualChannel object

Virtual channels.

watermark

No

Watermark object

Watermarking.

keyboard_mouse

No

keyboard_mouse object

Keyboards and mouse devices.

seamless

No

seamless object

Audio/Video bypass.

personalized_data_mgmt

No

personalized_data_mgmt object

Personalized data management.

custom

No

custom object

Custom policy.

record_audit

No

record_audit object

Screen recording audit.

Table 7 peripherals

Parameter

Mandatory

Type

Description

usb_custom_policy_debug

No

String

Device debugging policy.

usb_port_redirection

No

usb_port_redirection object

USB port redirection.

device_redirection

No

device_redirection object

Device redirection.

usb_device_common

No

usb_device_common object

USB and device smartcard options.

serial_port_redirection

No

serial_port_redirection object

Serial port redirection.

parallel_port_redirection

No

parallel_port_redirection object

Parallel port redirection.

driver_interface_redirection

No

driver_interface_redirection object

Driver interface redirection.

Table 8 usb_port_redirection

Parameter

Mandatory

Type

Description

usb_enable

No

Boolean

Whether to enable USB port redirection. Options:

false: disable;

true: enable

options

No

options object

USB port redirection options.

Table 9 options

Parameter

Mandatory

Type

Description

usb_image_enable

No

Boolean

Whether to enable image devices, such as scanners. Options:

false: disable;

true: enable

usb_video_enable

No

Boolean

Whether to enable video devices, such as cameras. Options:

false: disable;

true: enable

usb_printer_enable

No

Boolean

Whether to enable print devices, such as printers. Options:

false: disable;

true: enable

usb_storage_enable

No

Boolean

Whether to enable storage devices, such as USB flash drives. Options:

false: disable;

true: enable

wireless_devices_enable

No

Boolean

Whether to enable wireless devices, such as Bluetooth. Options:

false: disable;

true: enable

network_devices_enable

No

Boolean

Whether to enable network devices, such as wireless NICs. Options:

false: disable;

true: enable

usb_smart_card_enable

No

Boolean

Whether to enable smartcard devices, such as USB keys. Options:

false: disable;

true: enable

other_usb_devices_enable

No

Boolean

Whether to enable the redirection of other USB devices. Options:

false: disable;

true: enable

usb_redirection_customization_policy

No

String

Custom policy for USB port redirection. The value contains a maximum of 18,000 characters.

usb_redirection_mode

No

String

USB redirection mode. Options:

Classical mode

Common mode

Table 10 device_redirection

Parameter

Mandatory

Type

Description

printer_redirection

No

printer_redirection object

Printer redirection.

session_printer

No

session_printer object

Session printer.

camera_redirection

No

camera_redirection object

Camera redirection.

twain_redirection_enable

No

Boolean

Whether to enable TWAIN device redirection. Options:

false: disable;

true: enable

image_compression_level

No

String

Image compression level. Options:

none

low (highest speed)

medium (medium speed)

high (lowest speed)

lossless

low-loss

medium-loss

high-loss

hid_redirection

No

hid_redirection object

Human interface device (HID) redirection.

Table 11 printer_redirection

Parameter

Mandatory

Type

Description

printer_enable

No

Boolean

Whether to enable printer redirection. Options:

false: disable;

true: enable

options

No

options object

Printer redirection options.

Table 12 options

Parameter

Mandatory

Type

Description

mobile_printer_enable

No

Boolean

Mobile client printer redirection. Options:

false: disable;

true: enable

print_data_compression_mode

No

Boolean

Whether to enable data compression. Options:

false: disable;

true: enable

sync_client_default_printer_enable

No

Boolean

Whether to enable default client printer synchronization. Options:

false: disable;

true: enable

universal_printer_driver

No

String

Universal printer driver. By default, choose Universal Printing PS for Linux clients and HDP XPSDrv Driver for Windows clients. Options: HDP XPSDrv Driver; Universal Printing PCL 5 Universal Printing PCL 6 Universal Printing PS

Table 13 session_printer

Parameter

Mandatory

Type

Description

session_printer_enable

No

Boolean

Whether to enable session printers. Options:

false: disable;

true: enable

options

No

options object

Session printer options.

Table 14 options

Parameter

Mandatory

Type

Description

session_printer_customization_policy

No

String

Custom session printer policy. A maximum of 1,000 characters are allowed.

Table 15 camera_redirection

Parameter

Mandatory

Type

Description

video_compress_enable

No

Boolean

Whether to enable camera redirection. Options:

false: disable;

true: enable

options

No

options object

Camera redirection options.

Table 16 options

Parameter

Mandatory

Type

Description

camera_frame_rate

No

Integer

Camera frame rate (FPS). The value ranges from 1 to 30. Default: 15

camera_max_width

No

Integer

Camera maximum width (pixel). The value ranges from 1 to 9999. Default: 3000

camera_max_heigth

No

Integer

Camera maximum height (pixel). The value ranges from 1 to 9999. Default: 3000

camera_compression_method

No

String

Camera data compression method. The value is H.264.

Table 17 hid_redirection

Parameter

Mandatory

Type

Description

hid_redirection_enable

No

Boolean

Whether to enable HID redirection. Options:

false: disable;

true: enable

options

No

options object

HID options.

Table 18 options

Parameter

Mandatory

Type

Description

hid_redirection_customization_policy

No

String

Custom HID redirection policy.

Table 19 usb_device_common

Parameter

Mandatory

Type

Description

pcsc_smart_card_enable

No

String

Whether to enable PC/SC smartcard redirection. Options:

Enable: enabled

Closed: closed

Disable: disabled

common_options

No

common_options object

Options for both USB devices and device smartcards.

Table 20 common_options

Parameter

Mandatory

Type

Description

remove_smart_card_disconnect_enable

No

Boolean

Whether to enable smartcard removal to log out of user sessions. Options:

false: disable;

true: enable

Table 21 serial_port_redirection

Parameter

Mandatory

Type

Description

serial_port_enable

No

Boolean

Whether to enable serial port redirection. Options:

false: disable;

true: enable

options

No

options object

Serial port redirection options.

Table 22 options

Parameter

Mandatory

Type

Description

auto_connect_enable

No

Boolean

Whether to enable automatic connection to client serial ports. Options:

false: disable;

true: enable

Table 23 parallel_port_redirection

Parameter

Mandatory

Type

Description

parallel_port_enable

No

Boolean

Whether to enable parallel port redirection. Options:

false: disable;

true: enable

Table 24 driver_interface_redirection

Parameter

Mandatory

Type

Description

api_redir_driver_list

No

String

Custom drivers. Enter one or more driver file names or full paths of driver files installed on terminals. Separate file names or paths with semicolons (;). A maximum of 1,000 characters are allowed.

Table 25 audio

Parameter

Mandatory

Type

Description

audio_redirection_enable

No

Boolean

Whether to enable audio redirection. Options:

false: disable;

true: enable

play_volume

No

String

Playback volume.

If this parameter is not specified, the value is Do Not Set Volume.

Volume setting. The value ranges from 10 to 100, and the interval between two adjacent values is 5 in ascending order, for example, 10, 15, 20, and 25.

play_volume_ratio

No

String

Playback volume ratio. Options:

If this parameter is not specified, the value is Do Not Set Volume Ratio.

Low

Middle: medium

High

record_volume

No

String

Recording volume.

If this parameter is not specified, the value is Do Not Set Volume.

Volume setting. The value ranges from 10 to 100, and the interval between two adjacent values is 5 in ascending order, for example, 10, 15, 20, and 25.

record_volume_ratio

No

String

Recording volume ratio. Options:

If this parameter is not specified, the value is Do Not Set Volume Ratio.

Low

Middle: medium

High

audio_transmission_mode

No

String

Audio transmission mode. Options:

Reliable Transmission

Real Time Transmission

play_redirection_enable

No

Boolean

Whether to enable playback redirection. Options:

false: disable;

true: enable

play_classification

No

String

Playback scenario. Options:

Lossless

Speech Call

Music Play

Automatic Identification

play_quality

No

String

Playback quality. Options:

Low

Middle: medium

High

play_denoising

No

String

Playback denoising. Options:

Disabled.

Enabled: The value ranges from –100 to –5, and the interval between two adjacent values is 5 in ascending order, for example, –100, –95, –90, and –85.

play_agc

No

String

Playback AGC. Options: Disabled. Enabled: The value ranges from 4,000 to 32,000. From 10,000 on, the interval between two adjacent values is 1,000 in ascending order, for example, 4,000, 6,000, 8,000, 10,000, 11,000, 12,000 and 13,000.

play_crc

No

String

Playback CRC. Options:

Disable CRC

Enable CRC

play_device_mode

No

String

Playback device mode. Options:

Play Device In Shared Mode

Play Device In Exclusive Mode

play_delay_threshold

No

String

Playback delay threshold. The value ranges from 160 to 2,500. The values less than 400 are in ascending order with an interval of 40, and the values between 400 and 1,000 are in ascending order with an interval of 50. For example, the values can be as follows: 2,500, 2,000, 1,800, 1,500, 1,200, 1,000, 950, 900, 850.

play_amplitude_threshold

No

String

Playback amplitude threshold. The values can be: 2,048, 4,096, 5,120, 6,144, 7,168, 8,192.

play_prefill_data

No

String

Playback prefill data. Options: Do Not Prefill Data; Prefill Data: The value ranges from 50 to 2,000. The values less than 250 are in an ascending order with an interval of 50, and the values between 250 and 500 are in an ascending order with an interval of 100. For example, the values can be as follows: 2,000, 1,500, 1,000, 500, 400, 300, 250.

record_redirection_enable

No

Boolean

Whether to enable recording redirection. Options:

false: disable;

true: enable

record_classification

No

String

Recording scenario. Options:

Lossless

Speech Call

Music Record

Automatic Identification

record_quality

No

String

Recording quality. Options:

Low

Middle: medium

High

record_denoising

No

String

Recording denoising. Options:

Disabled.

Enabled: The value ranges from –100 to –5, and the interval between two adjacent values is 5 in ascending order, for example, –100, –95, –90, and –85.

record_agc

No

String

Recording AGC. Options: Disabled. Enabled: The value ranges from 4,000 to 32,000. From 10,000 on, the interval between two adjacent values is 1,000 in ascending order, for example, 4,000, 6,000, 8,000, 10,000, 11,000, 12,000 and 13,000.

record_crc

No

String

Recording CRC. Options:

Disable CRC

Enable CRC

record_device_mode

No

String

Recording device mode. Options:

Record Device In Shared Mode

Record Device In Exclusive Mode

record_delay_threshold

No

String

Recording delay threshold. The value ranges from 160 to 2,500. The values less than 400 are in ascending order with an interval of 40, and the values between 400 and 1,000 are in ascending order with an interval of 50. For example, the values can be as follows: 2,500, 2,000, 1,800, 1,500, 1,200, 1,000, 950, 900, 850.

record_amplitude_threshold

No

String

Recording amplitude threshold. The values can be: 2,048, 4,096, 5,120, 6,144, 7,168, 8,192.

Table 26 client

Parameter

Mandatory

Type

Description

automatic_reconnection_interval

No

Integer

Automatic reconnection interval, in second. The value ranges from 1 to 50. Default: 5

session_persistence_time

No

Integer

Session persistence duration, in second. The value ranges from 0 to 180. Default: 180

autoclose_monitor_after_locked

No

Boolean

Automatic monitor shutdown after screen locking. Options:

false: disable;

true: enable

autoclose_monitor_options

No

autoclose_monitor_options object

Options for automatic monitor shutdown.

forbid_screen_capture

No

Boolean

Whether to enable screen capture prevention. Options:

false: disable;

true: enable

client_machine_join_domain

No

Boolean

Whether to verify the domain of a terminal.

false: disable;

true: enable

client_type

No

client_type object

Terminal type login control.

Table 27 autoclose_monitor_options

Parameter

Mandatory

Type

Description

autoclose_monitor_wait_time

No

Integer

Time before automatic monitor shutdown, in second. The value ranges from 10 to 600,000. Default: 300

Table 28 client_type

Parameter

Mandatory

Type

Description

client_type_limit

No

Boolean

Whether to enable terminal type login control.

false: disable;

true: enable

options

No

options object

Options for terminal type login control.

Table 29 options

Parameter

Mandatory

Type

Description

sc_type_window

No

Boolean

Whether to select the Windows client. Options:

false: not selected

true: selected

sc_type_mac

No

Boolean

Whether to select the macOS client. Options:

false: not selected

true: selected

sc_type_android

No

Boolean

Whether to select the Android client. Options:

false: not selected

true: selected

sc_type_linux

No

Boolean

Whether to select the Linux client. Options:

false: not selected

true: selected

sc_type_h5

No

Boolean

Whether to select the web client. Options:

false: not selected

true: selected

sc_type_ios

No

Boolean

Whether to select the iOS client. Options:

false: not selected

true: selected

sc_type_harmony_os

No

Boolean

Whether to select the HarmonyOS client. Options:

false: not selected

true: selected

tc_type_all

No

Boolean

Whether to select all hardware terminals. Options:

false: not selected

true: selected

Table 30 display

Parameter

Mandatory

Type

Description

display_level

No

String

Display level. Options:

LEVEL 1

LEVEL 2

LEVEL 3

LEVEL 4 (default/recommended)

LEVEL 5

options

No

options object

Display level options.

rendering_acceleration_enable

No

Boolean

Whether to enable rendering acceleration. Options:

false: disable;

true: enable

rendering_acceleration_options

No

rendering_acceleration_options object

Rendering acceleration options.

adaptive_bitrate_control_enable

No

Boolean

Whether to enable adaptive bitrate. Options:

false: disable;

true: enable

adaptive_bitrate_control_options

No

adaptive_bitrate_control_options object

Adaptive bitrate options.

video_card_memory_size

No

Integer

GPU card cache (MB). The value ranges from 0 to 64. Default: 64

configuration1_enable

No

Boolean

Whether to enable configuration item 1. Options:

false: disable;

true: enable

driver_delegation_mode_enable

No

Boolean

Whether to enable driver delegation. Options:

false: disable;

true: enable

driver_delegation_latency

No

Integer

Driver delegation latency (x 30 ms). The value ranges from 1 to 100. Default: 80

video_latency

No

Integer

Driver delegation video latency (x 30 ms). The value ranges from 1 to 100. Default: 80

change_resolution_vm

No

Boolean

Whether to enable resolution change. Options:

false: disable;

true: enable

application_recognition

No

String

Application recognition. A maximum of 1,024 characters are allowed.

duplicate_display_enable

No

Boolean

Duplicate display. Options:

false: disable;

true: enable

default_mapping_order

No

String

Default screen mapping sequence. Default: 1, 2, 3, 4

duplicate_display_mode

No

String

Duplicate display mode. Options:

One-to-One: Only one channel is supported.

One-to-Many: Multiple channels are supported.

Table 31 options

Parameter

Mandatory

Type

Description

display_bandwidth

No

Integer

Bandwidth (kbit/s). The value ranges from 256 to 25,000. Default: 20,000

frame_rate

No

Integer

Frame rate (FPS). The value ranges from 1 to 60. Default: 25

video_frame_rate

No

Integer

Video frame rate (FPS). The value ranges from 1 to 60. Default: 30

min_image_cache

No

Integer

Minimum capacity for image cache (MB). The value ranges from 0 to 300. Default: 200

smoothing_factor

No

Integer

Lossy compression recognition threshold. The value ranges from 0 to 255. Default: 60

lossless_compression_mode

No

String

Lossless compression. Options:

Basic Compression

Deep Compression

deep_compression_options

No

deep_compression_options object

Deep compression options.

lossy_compression_quality

No

Integer

Lossy compression quality. The value ranges from 20 to 100. Default: 85

color_enhancement_enable

No

Boolean

Whether to enable color enhancement for office work. Options:

false: disable;

true: enable

quality_bandwidth_first

No

String

Quality/Bandwidth first. Options:

Quality First

Bandwidth First

video_bit_rate_options

No

video_bit_rate_options object

Video bitrate options.

peak_video_bit_rate

No

Integer

Peak video bitrate (kbit/s). The value ranges from 256 to 100,000. Default: 18,000

video_quality_options

No

video_quality_options object

Video quality options.

gop_size

No

Integer

GOP size. The value ranges from 0 to 65535. Default: 100

encoding_preset

No

String

Encoding preset. Options:

Preset 1

Preset 2

Preset 3

Preset 4

Preset 5

Preset 6

Preset 7

Table 32 deep_compression_options

Parameter

Mandatory

Type

Description

deep_compression_level

No

String

Deep compression level. Options:

Compression grade 0

Compression grade 1

Compression grade 2

Compression grade 3

Compression grade 4

Compression grade 5

Compression grade 6

Compression grade 7

Compression grade 8

Compression grade 9

Table 33 video_bit_rate_options

Parameter

Mandatory

Type

Description

average_video_bit_rate

No

Integer

Average video bitrate (kbit/s). The value ranges from 256 to 100,000. Default: 18,000

Table 34 video_quality_options

Parameter

Mandatory

Type

Description

average_video_quality

No

Integer

Average video quality. The value ranges from 5 to 59. Default: 15

lowest_video_quality

No

Integer

Lowest video quality. The value ranges from 5 to 69. Default: 25

highest_video_quality

No

Integer

Highest video quality. The value ranges from 1 to 59. Default: 7

Table 35 rendering_acceleration_options

Parameter

Mandatory

Type

Description

video_acceleration_enhancement_enable

No

Boolean

Whether to enable video acceleration enhancement. Options:

false: disable;

true: enable

video_optimization_enable

No

Boolean

Whether to enable video scene optimization. Options:

false: disable;

true: enable

gpu_color_optimization_enable

No

Boolean

Whether to enable GPU color optimization. Options:

false: disable;

true: enable

video_recognition_threshold

No

Integer

Video recognition threshold. The value ranges from 0 to 500. Default: 10

frame_rate_statistical_length

No

Integer

Frame rate statistical length. The value ranges from 2 to 100. Default: 4

image_quality_threshold

No

Integer

Image quality threshold. The value ranges from 0 to 100. Default: 0

refresh_frequency_threshold

No

Integer

Refresh frequency threshold. The value ranges from 1 to 100. Default: 3

exiting_video_area_threshold

No

Integer

Threshold of exiting the video area. The value ranges from 0 to 100. Default: 8

min_video_width

No

Integer

Minimum video width. The value ranges from 0 to 1,280. Default: 191

min_video_length

No

Integer

Minimum video height. The value ranges from 0 to 1,280. Default: 191

single_frame_natural_percentage

No

String

Threshold of the single-frame natural image block percentage. The value ranges from 0.000001 to 1. Default: 0.3

cyclical_natural_images_number

No

Integer

Threshold of cyclical natural image quantity percentage. The value ranges from 0 to 100. Default: 2

non_natural_image_percentage

No

String

Threshold of the non-natural image area percentage. The value ranges from 0.000001 to 1. Default: 0.85

non_natural_images_number

No

Integer

Threshold of non-natural image quantity percentage. The value ranges from 0 to 100. Default: 25

Table 36 adaptive_bitrate_control_options

Parameter

Mandatory

Type

Description

peak_bandwidth_suppression_enable

No

Boolean

Whether to enable peak bandwidth suppression. Options:

false: disable;

true: enable

expected_average_network_latency

No

Integer

Expected average network latency, in millisecond. The value ranges from 1 to 2,000. Default: 160

network_latency_threshold1

No

Integer

Network latency threshold 1 (ms). The value ranges from 1 to 2,000. Default: 160

network_latency_threshold2

No

Integer

Network latency threshold 2 (ms). The value ranges from 1 to 2,000. Default: 300

min_dynamic_frame_rate

No

Integer

Minimum dynamic frame rate (FPS). The value ranges from 1 to 60. Default: 17

min_dynamic_frame_rate_lv1

No

Integer

Minimum dynamic frame rate level 1 (FPS). The value ranges from 1 to 60. Default: 17

min_dynamic_frame_rate_lv2

No

Integer

Minimum dynamic frame rate level 2 (FPS). The value ranges from 1 to 60. Default: 10

rtt_threshold

No

Integer

Frame rate control parameter 1. The value ranges from 0 to 1,000. Default: 20

min_add_framerate

No

Integer

Frame rate control parameter 2. The value ranges from 0 to 120. Default: 8

max_add_framerate

No

Integer

Frame rate control parameter 3. The value ranges from 0 to 120. Default: 20

sub_framerate

No

Integer

Frame rate control parameter 4. The value ranges from 0 to 120. Default: 25

adaptive_bandwidth_lower_limit

No

Integer

Adaptive bandwidth lower limit, in kbit/s. The value ranges from 100 to 20,000. Default: 500

adaptive_compression_quality_lower_limit

No

Integer

Lower limit of adaptive lossy compression quality. The value ranges from 1 to 100. Default: 60

adaptive_compression_quality_upper_limit

No

Integer

Upper limit of adaptive lossy compression quality. The value ranges from 1 to 100. Default: 85

adaptive_compression_quality_increase_limit

No

Integer

Increase limit of adaptive lossy compression quality. The value ranges from 1 to 100. Default: 5

adaptive_compression_quality_decrease_limit

No

Integer

Decrease limit of adaptive lossy compression quality. The value ranges from 1 to 100. Default: 10

adaptive_average_quality_lower_limit

No

Integer

Lower limit of adaptive average video quality. The value ranges from 5 to 50. Default: 15

adaptive_average_quality_upper_limit

No

Integer

Upper limit of adaptive average video quality. The value ranges from 5 to 50. Default: 25

adaptive_average_quality_increase_limit

No

Integer

Increase limit of adaptive average video quality. The value ranges from 1 to 50. Default: 3

adaptive_average_quality_decrease_limit

No

Integer

Decrease limit of adaptive average video quality. The value ranges from 1 to 50. Default: 1

adaptive_min_quality_lower_limit

No

Integer

Lower limit of adaptive minimum video quality. The value ranges from 5 to 69. Default: 25

adaptive_min_quality_upper_limit

No

Integer

Upper limit of adaptive minimum video quality. The value ranges from 5 to 69. Default: 30

adaptive_min_quality_increase_limit

No

Integer

Increase limit of adaptive minimum video quality. The value ranges from 1 to 50. Default: 3

adaptive_min_quality_decrease_limit

No

Integer

Decrease limit of adaptive minimum video quality. The value ranges from 1 to 50. Default: 1

Table 37 file_and_clipboard

Parameter

Mandatory

Type

Description

file_redirection

No

file_redirection object

File redirection.

clip_length_limit_flag_c2s

No

Boolean

Clipboard length.

clip_length_limit_c2s

No

Integer

Client clipboard length.

clip_length_limit_flag_s2c

No

Boolean

Clipboard length.

clip_length_limit_s2c

No

Integer

Client clipboard length.

fd_mobile_client_redir_enable

No

Boolean

Whether to enable mobile client file redirection. Options:

false: disable;

true: enable

clipboard_redirection

No

String

Clipboard redirection. Options:

DISABLED (default)

SERVER_TO_CLIENT_ENABLED (from the server to the client)

CLIENT_TO_SERVER_ENABLED (from the client to the server)

TWO_WAY_ENABLED (two-way)

clipboard_redirection_options

No

clipboard_redirection_options object

Clipboard redirection options.

Table 38 file_redirection

Parameter

Mandatory

Type

Description

redirection_mode

No

String

File redirection. Options:

DISABLED (default)

READ_ONLY

READ_AND_WRITE

options

No

options object

File redirection options.

vm_send_file_client

No

Boolean

Whether to enable the function of sending files from the VM to the client. Options:

false: disable;

true: enable

redirection_send_file_options

No

redirection_send_file_options object

Options for both redirection and file sending.

Table 39 options

Parameter

Mandatory

Type

Description

fluid_control_switch_enable

No

Boolean

Whether to enable rate limit. Options:

false: disable;

true: enable

fluid_control_options

No

fluid_control_options object

Rate limit options.

compression_switch_enable

No

Boolean

Whether to enable compression. Options:

false: disable;

true: enable

compression_switch_options

No

compression_switch_options object

Compression options.

linux_file_size_supported_enable

No

Boolean

Whether to enable the function of setting the file size in Linux. Options:

false: disable;

true: enable

linux_file_size_supported_options

No

linux_file_size_supported_options object

Options for setting the file size in Linux.

linux_root_mount_switch_enable

No

Boolean

Whether to enable root directory mount in Linux. Options:

false: disable;

true: enable

linux_root_dir_list

No

String

Mount path of the Linux root directory. Default: \var\log

linux_file_mount_path

No

String

Mount path of the Linux file system. Default: \media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media

linux_fixed_drive_file_system_format

No

String

Linux fixed driver file system format.

linux_removable_drive_file_system_format

No

String

Linux removable driver file system format. Default: vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir|lifs

linux_cdrom_drive_file_system_format

No

String

Linux CD-ROM driver file system format. Default: cd9660|iso9660|udf

linux_network_drive_file_system_format

No

String

Linux network driver file system format. Default: smbfs|afpfs|cifs

path_separator

No

String

Path separator. Default: |

fixed_drive_enable

No

Boolean

Whether to enable fixed drivers (such as local disks). Options:

false: disable;

true: enable

removable_drive_enable

No

Boolean

Whether to enable removable drivers (such as USB flash drives). Options:

false: disable;

true: enable

cd_rom_drive_enable

No

Boolean

Whether to enable CD-ROM drivers. Options:

false: disable;

true: enable

network_drive_enable

No

Boolean

Whether to enable network drivers. Options:

false: disable;

true: enable

Table 40 fluid_control_options

Parameter

Mandatory

Type

Description

good_network_latency

No

Integer

Good network latency threshold (ms). The value ranges from 1 to 1,000. Default: 30

normal_network_latency

No

Integer

Normal network latency threshold (ms). The value ranges from 1 to 1,000. Default: 70

poor_network_latency

No

Integer

Poor network latency threshold (ms). The value ranges from 1 to 1,000. Default: 100

reducing_step

No

Integer

Reducing step (KB). The value ranges from 1 to 100. Default: 20

slow_increasing_step

No

Integer

Slow increasing step (KB). The value ranges from 1 to 100. Default: 10

quick_increasing_step

No

Integer

Quick increasing step (KB). The value ranges from 1 to 100. Default: 20

start_speed

No

Integer

Initial transmission speed (KB/s). The value ranges from 1 to 10,240. Default: 1,024

test_block_size

No

Integer

Speed test block size (KB). The value ranges from 64 to 1,024. Default: 64

test_time_gap

No

Integer

Speed test block interval (ms). The value ranges from 1,000 to 100,000. Default: 10,000

Table 41 compression_switch_options

Parameter

Mandatory

Type

Description

compression_threshold

No

Integer

Compression threshold (byte). The value ranges from 0 to 10,240. Default: 512

minimum_compression_rate

No

Integer

Minimum compression rate. The value ranges from 0 to 1,000. Default: 900

Table 42 linux_file_size_supported_options

Parameter

Mandatory

Type

Description

linux_file_size_supported_threshold

No

Integer

File size threshold in Linux (byte). The value ranges from 0 to 4,096. Default: 100

Table 43 redirection_send_file_options

Parameter

Mandatory

Type

Description

read_write_speed

No

Integer

Read/Write speed (kbit/s). The value ranges from 0 to 2147483647. Default: 0

Table 44 clipboard_redirection_options

Parameter

Mandatory

Type

Description

rich_text_redirection_enable

No

Boolean

Whether to enable clipboard rich text redirection. Options:

false: disable;

true: enable

clipboard_file_redirection_enable

No

Boolean

Whether to enable clipboard file redirection. Options:

false: disable;

true: enable

Table 45 Session

Parameter

Mandatory

Type

Description

vdi

No

Vdi object

VDI.

self_help_console

No

Boolean

Whether to enable preemption login to the self-help console. Options: false: disable; true: enable

disconnect_on_lock_flag

No

Boolean

Whether to disconnect after the screen is locked.

auto_lock_start_time

No

String

Start time when the lock takes effect. The format is hh:mm:ss.

auto_lock_end_time

No

String

Start time when the lock takes effect. The format is hh:mm:ss.

Table 46 Vdi

Parameter

Mandatory

Type

Description

auto_lock_enable

No

Boolean

Whether to enable automatic screen locking. Options: false: disable; true: enable

auto_lock_options

No

AutoLockOptions object

Options available after automatic screen locking is enabled.

disconnect_logout_enable

No

Integer

Whether to enable automatic logout upon disconnection. Options: 0: disable; 1: enable

disconnect_logout_options

No

DisconnectLogoutOptions object

Options available after automatic logout upon disconnection is enabled.

disconnect_hibernate_enable

No

Boolean

Whether to enable automatic logout upon disconnection. Options: 0: disable; 1: enable

disconnect_hibernate_options

No

disconnect_hibernate_options object

Options for hibernation upon disconnection.

no_operation_hibernate_enable

No

Boolean

Whether to enable automatic logout upon disconnection. Options: 0: disable; 1: enable

no_operation_hibernate_options

No

no_operation_hibernate_options object

Do not select the hibernation option.

Table 47 AutoLockOptions

Parameter

Mandatory

Type

Description

auto_lock_minutes

No

Integer

Time before screen locking, in minute. The value ranges from 3 to 86,400. Default: 10

auto_disconnect

No

String

Automatic disconnection or logout. Options: AUTO_DISCONNECT (automatic disconnection); AUTO_LOGOUT (automatic logout); DISABLED (disabled); AUTO_RESTART (default, automatic restart); AUTO_STOP (automatic shutdown); HIBERNATE (hibernation)

options

No

AutoDisconnectOrLogoutControlOptions object

Options available after automatic disconnection or automatic logout is enabled.

Table 48 AutoDisconnectOrLogoutControlOptions

Parameter

Mandatory

Type

Description

auto_disconnect_minutes

No

Integer

Time before disconnection or logout, in minute. The value ranges from 1 to 86,400. Default: 1,440

Table 49 DisconnectLogoutOptions

Parameter

Mandatory

Type

Description

disconnect_logout_minutes

No

Integer

Time before automatic logout upon disconnection, in minute. The value ranges from 3 to 86,400. Default: 10

Table 50 disconnect_hibernate_options

Parameter

Mandatory

Type

Description

disconnect_hibernate_minutes

No

Integer

Hibernation duration upon disconnection.

Table 51 no_operation_hibernate_options

Parameter

Mandatory

Type

Description

no_operation_hibernate_minutes

No

Integer

Policy group ID.

Table 52 VirtualChannel

Parameter

Mandatory

Type

Description

virtual_channel_control_enable

No

Boolean

Whether to enable the virtual channel policy. Options: false: disable; true: enable

options

No

VirtualChannelOptions object

Virtual channel policy options.

Table 53 VirtualChannelOptions

Parameter

Mandatory

Type

Description

custom_virtual_channel_name

No

String

Custom registered virtual channel name. Currently, only ASCII characters are supported. The value can contain a maximum of 65,535 characters.

virtual_channel_plugin_details

No

String

Virtual channel download details (Base64-encrypted). Before encryption, only ASCII characters are supported. The value can contain a maximum of 65,535 characters.

third_party_plugin_name

No

String

Third-party plug-in name. The value can contain a maximum of 65,535 characters.

Table 54 Watermark

Parameter

Mandatory

Type

Description

watermark_enable

No

Boolean

Indicates whether to enable the watermark policy. Options: false: disable; true: enable

options

No

WatermarkOptions object

Watermark policy options.

Table 55 WatermarkOptions

Parameter

Mandatory

Type

Description

show_style

No

String

Display mode. Options: FIXED (fixed position); RANDOM (random motion)

color

No

String

Color. Format: RRGGBB. Default: 2a2a2a

font_size

No

Integer

Font size. The value ranges from 1 to 200. Default: 30

opacity_setting

No

String

Opacity (%). The value ranges from 0 to 100. Default: 12.5

content_item_count

No

Integer

Number of watermarks. The value ranges from 1 to 30. Default: 1

display_format

No

String

Watermark content display format.

lean

No

Integer

Tilt. The value ranges from –90 to 90. Default: –45

content_customized

No

String

Custom content, which cannot contain special characters such as >.

content_color

No

String

Content color.

watermark_security_access

No

Boolean

Whether to enable the security-first mode.

user_extend_info_switch

No

Boolean

Whether to enable extended user information. false: disable; true: enable

user_extend_info

No

String

Extended user information.

Table 56 keyboard_mouse

Parameter

Mandatory

Type

Description

mouse_feedback

No

String

VM mouse device feedback. Options:

SELFADAPTION: adaptive mouse device feedback

FORCE: forcible mouse device feedback

CLOSE: no mouse device feedback

mouse_simulation_mode

No

String

VM mouse device simulation mode. Options:

ABSOLUTE_POSITION: absolute position simulation

RELATIVE_POSITION: relative position simulation

external_cursor_feedback

No

Boolean

Whether to enable VM external cursor feedback. Options:

false: disable;

true: enable

selfhelp_console_enable

No

Boolean

Whether to enable preemption login to the self-help console. Options:

false: disable;

true: enable

client_mouse_send_interval

No

Integer

Interval for sending mouse device operations on the client. The value ranges from 1 to 30. Default: 30

windows_client_keyboard_mode

No

String

Windows client keyboard mode. Options:

GLOBAL: global mode for Windows client keyboards (default)

WINDOW: windowed mode for for Windows client keyboards

windows_client_mouse_mode

No

String

Windows client mouse device mode. Options:

GLOBAL: global mode for Windows client mouse devices

WINDOW: windowed mode for Windows client mouse devices (default)

linux_client_keyboard_mode

No

String

Linux client keyboard mode. Options:

EVENT: event mode for Linux client keyboards (default)

GRAPH: graphics mode for Linux client keyboards

linux_client_mouse_mode

No

String

Linux client mouse device mode. Options:

EVENT: event mode for Linux client mouse devices (default)

GRAPH: graphics mode for Linux client mouse devices

special_keyboard

No

Boolean

Special keyboard. Options:

false: disable;

true: enable

joy_stick_flag

No

Boolean

Joystick. Options:

false: disable;

true: enable

Table 57 seamless

Parameter

Mandatory

Type

Description

seamless_enable

No

Boolean

Whether to enable audio/video bypass. Options:

false: disable;

true: enable

options

No

options object

General audio/video settings.

Table 58 options

Parameter

Mandatory

Type

Description

seamless_apply_path

No

String

Software path. A maximum of 1,000 characters are allowed.

Table 59 personalized_data_mgmt

Parameter

Mandatory

Type

Description

personalized_data_mgmt_path

No

String

Personalized data management path.

user_data_roaming_enable

No

Boolean

User data roaming.

user_data_roaming_options

No

user_data_roaming_options object

User data roaming options.

user_folder_redirection_enable

No

Boolean

Enables user folder redirection.

user_folder_redirection_options

No

user_folder_redirection_options object

User folder redirection options.

logoff_delete_user_configuration

No

Boolean

Enables user folder redirection.

network_drive_mapping_enable

No

Boolean

Enables user folder redirection.

network_drive_mapping_options

No

network_drive_mapping_options object

Network driver mapping options.

Table 60 user_data_roaming_options

Parameter

Mandatory

Type

Description

profile_streaming_enable

No

Boolean

Whether to enable profile streaming.

roamed_files_local_path

No

String

Local path of roamed files.

exclude_folders_path

No

String

Path of an excluded folder.

roaming_registry_method

No

String

Path of an excluded folder.

roaming_registry_path

No

String

Path of roaming registration.

Table 61 user_folder_redirection_options

Parameter

Mandatory

Type

Description

restore_local_directories_enable

No

Boolean

Enables the restoration of local directories.

appData_roaming_enale

No

Boolean

Enables application data roaming.

redirec_desktop

No

Boolean

Desktop redirection.

redirec_start_menu

No

Boolean

Start menu.

redirec_documents

No

Boolean

Document.

redirec_pictures

No

Boolean

Photo.

redirec_music

No

Boolean

Music.

redirec_videos

No

Boolean

Audio recording.

redirec_favorites

No

Boolean

Favorite.

redirec_contacts

No

Boolean

Audio recording.

redirec_downloads

No

Boolean

Download.

redirec_links

No

Boolean

Link

redirec_searches

No

Boolean

Search.

redirec_saved_games

No

Boolean

Game storage.

Table 62 network_drive_mapping_options

Parameter

Mandatory

Type

Description

network_drive_mapping_path

No

String

Network drive mapping path.

drive_letter

No

String

Path of an excluded folder.

Table 63 custom

Parameter

Mandatory

Type

Description

custom_configuration1_enable

No

Boolean

Whether to enable custom configuration.

options

No

options object

General audio/video settings.

Table 64 options

Parameter

Mandatory

Type

Description

custom_configuration1_rule

No

String

Custom configuration rule.

Table 65 record_audit

Parameter

Mandatory

Type

Description

enable

No

Boolean

Whether to enable screen recording audit. Options:

false: disable;

true: enable

rules

No

rules object

Screen recording rules.

storage_type

No

String

Storage type. Options:

OBS: OBS bucket

SFTP: SFTP interconnection

obs_bucket_source

No

String

OBS bucket source. Options:

AUTO_CREATE: automatically created

CREATED: created

obs_bucket_name

No

String

OBS bucket name

retention_duration

No

Integer

Retention period of a screen recording file, in days. The value ranges from 1 to 180. 0 indicates that the file is retained permanently.

Table 66 rules

Parameter

Mandatory

Type

Description

rule

No

RecordAuditRule object

Rule.

Table 67 RecordAuditRule

Parameter

Mandatory

Type

Description

record_type

No

String

Recording type. Options:

whole: continuous screen recording

interval: interval screen recording

userOperations: screen recording by users

sessionMonitoring: screen recording of the session lifecycle

interval_record_start_time

No

String

Start time of interval-based screen recording. This parameter is valid only when interval is used. The format is hh:mm.

interval_record_end_time

No

String

End time of interval-based screen recording. This parameter is valid only when interval is used. The format is hh:mm.

op_type

No

String

Operation triggering type. This parameter is valid only when userOperations is used. Options:

input: Screen recording is started once the user enters content.

filecopy: Screen recording is started once the user copies a file.

audio_record

No

Boolean

Whether to enable audio recording. Options:

false: disable;

true: enable

fps

No

String

Recording frame rate. The value can be 2, 5, 10, or 15.

duration

No

String

Duration of a single video recording file, in minutes. The value can be 10, 20, 30, or 60.

resolution

No

String

Resolution settings. The value can be 720P, 1080P, or original.

event_enable

No

Boolean

Whether to enable key event audit. Options:

false: disabled

true: enabled

file_suffix

No

String

File name extension. Use vertical bars (|) to separate multiple file name extensions.

regit_paths

No

String

Registry path. Use vertical bars (|) to separate multiple registry paths.

app_filter_type

No

String

Application filtering type. The value can be black (blacklist) or white (whitelist).

app_white_list

No

String

Enables or disables the application whitelist. If it is enabled, only the whitelisted applications are monitored.

app_black_list

No

String

Enables or disables the application blacklist. Blacklisted applications will be ignored.

Response Parameters

Status code: 201

Table 68 Response body parameters

Parameter

Type

Description

id

String

Policy group ID.

Status code: 400

Table 69 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 70 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 71 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 72 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 73 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 74 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 75 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

POST /v2/29dfe82ada564ac2b927e1ff036d9a9b/policy-groups

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

Example Responses

Status code: 201

Response to the request for creating a policy group.

{
  "id" : "8885bcc45d547b41015d547d227e0000"
}

Status Codes

Status Code

Description

201

Response to the request for creating a policy group.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Utilizamos cookies para mejorar nuestro sitio y tu experiencia. Al continuar navegando en nuestro sitio, tú aceptas nuestra política de cookies. Descubre más

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback