You can create a region-independent cloud desktop policy.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecd:CreateCenterPolicy |
none |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
Region ID. This feature is region-independent. Set this parameter to cn-shanghai. Valid values:
|
cn-shanghai |
| ResourceType |
string |
Yes |
Resource type. Valid values:
|
desktop |
| BusinessType |
integer |
Yes |
Business type. Valid values:
|
1 |
| Clipboard |
string |
No |
Clipboard permission. Valid values:
|
off |
| LocalDrive |
string |
No |
Local disk mapping permission. Valid values:
|
off |
| UsbRedirect |
string |
No |
USB redirection. Valid values:
|
off |
| PrinterRedirect |
string |
No |
Printer redirection policy. This parameter takes effect only when no printer redirection policy is configured in DeviceRedirects. Valid values:
|
off |
| VisualQuality |
string |
No |
Image display quality policy. Valid values:
|
low |
| GpuAcceleration |
string |
No |
Enable image quality policy for graphics-intensive cloud desktops. Enable this policy if you require high performance and user experience, such as in professional design scenarios. Valid values:
|
off |
| Html5FileTransfer |
string |
No |
Web client file transfer policy. Valid values:
|
off |
| Watermark |
string |
No |
Watermark. Valid values:
|
off |
| Name |
string |
Yes |
Policy name. |
testPolicyGroupName |
| WatermarkType |
string |
No |
Watermark type. You can select up to three types, separated by commas. Note
If you set this parameter to Valid values:
|
EndUserId,HostName,ClientTime |
| WatermarkCustomText |
string |
No |
If you set the |
test |
| WatermarkTransparencyValue |
integer |
No |
Watermark opacity. A higher value indicates lower transparency. Valid values: 10 to 100. |
10 |
| WatermarkSecurity |
string |
No |
Blind watermark security priority rule. Valid values:
|
on |
| CameraRedirect |
string |
No |
Local camera redirection. This parameter takes effect only when no local camera redirection policy is configured in DeviceRedirects. Valid values:
|
off |
| NetRedirect |
string |
No |
Enable network redirection. Note
This feature is in invitational preview and is not publicly available. Valid values:
|
off |
| AppContentProtection |
string |
No |
Enable screenshot prevention. Valid values:
|
off |
| RemoteCoordinate |
string |
No |
Mouse and keyboard control permissions during remote assistance. Valid values:
|
fullControl |
| InternetCommunicationProtocol |
string |
No |
Network communication protocol. Valid values:
|
both |
| VideoRedirect |
string |
No |
Multimedia redirection. Valid values:
|
on |
| WatermarkColor |
integer |
No |
Watermark font color. Valid values: 0 to 16777215. |
0 |
| WatermarkDegree |
number |
No |
Watermark tilt angle. Valid values: -10 to -30. |
-10 |
| WatermarkFontSize |
integer |
No |
Watermark font size. Valid values: 10 to 20. |
10 |
| WatermarkFontStyle |
string |
No |
Watermark font style. Valid values:
|
plain |
| WatermarkRowAmount |
integer |
No |
Number of watermark rows. Valid values: 3 to 10. |
3 |
| WatermarkColumnAmount |
integer |
No |
Number of watermark columns. Valid values: 3 to 10. |
3 |
| CpuProtectedMode |
string |
No |
CPU protection mode switch. Valid values:
|
off |
| CpuRateLimit |
integer |
No |
CPU overall usage percentage. Valid values: 70 to 90. |
70 |
| CpuSampleDuration |
integer |
No |
CPU overall sampling duration. Valid values: 10 to 60. Unit: seconds. |
60 |
| CpuSingleRateLimit |
integer |
No |
CPU single-core usage percentage. Valid values: 70 to 100. |
70 |
| CpuDownGradeDuration |
integer |
No |
CPU downclocking duration. Valid values: 30 to 120. Unit: seconds. |
30 |
| MemoryProtectedMode |
string |
No |
Memory protection mode switch. Valid values:
|
off |
| MemoryRateLimit |
integer |
No |
Memory overall usage percentage. Valid values: 70 to 90. |
70 |
| MemorySampleDuration |
integer |
No |
Memory overall sampling duration. Valid values: 30 to 60. Unit: seconds. |
40 |
| MemorySingleRateLimit |
integer |
No |
Memory usage percentage per worker. Valid values: 30 to 60. |
40 |
| MemoryDownGradeDuration |
integer |
No |
Memory downclocking duration per worker. Valid values: 30 to 120. Unit: seconds. |
40 |
| EndUserApplyAdminCoordinate |
string |
No |
User requests administrator assistance. Valid values:
|
off |
| EndUserGroupCoordinate |
string |
No |
Users in the same office network share cloud desktops. Valid values:
|
off |
| Scope |
string |
No |
Policy scope. Valid values:
|
GLOBAL |
| Recording |
string |
No |
Enable screen recording. Valid values:
|
off |
| RecordingAudio |
string |
No |
Options for recording cloud desktop audio. Valid values:
|
on |
| RecordingStartTime |
string |
No |
Screen recording start time. Format: HH:MM:SS. This parameter takes effect only when |
08:00:00 |
| RecordingEndTime |
string |
No |
Screen recording end time. Format: HH:MM:SS. This parameter takes effect only when |
08:59:00 |
| RecordingFps |
string |
No |
Screen recording frame rate. Unit: FPS. |
2 |
| RecordingDuration |
integer |
No |
Duration for viewing recorded files. Unit: minutes. Recorded files are automatically split and uploaded to the bucket based on the specified duration. When a file reaches 300 MB, it is rolled over for updates. Valid values: 10 to 60. |
10 |
| RecordingExpires |
integer |
No |
Retention period for recorded files. Valid values: 1 to 180 days. |
15 |
| RecordingUserNotify |
string |
No |
Notify end users that screen recording is enabled. Valid values:
|
off |
| RecordingUserNotifyMessage |
string |
No |
Message to notify end users that screen recording is enabled. |
录屏已开启 |
| AdminAccess |
string |
No |
Whether users have administrative permission after logging on to cloud desktops. Note
This feature is in invitational preview and is not publicly available. Valid values:
|
deny |
| EnableSessionRateLimiting |
string |
No |
Session bandwidth throttling. Valid values:
|
off |
| SessionMaxRateKbps |
integer |
No |
Maximum session bandwidth throttling rate. Unit: Kbps. Valid values: 2000 to 100000. |
2000 |
| DisplayMode |
string |
No |
Display mode. Valid values:
|
clientCustom |
| StreamingMode |
string |
No |
Streaming mode adaptation scenario. Valid values:
|
smooth |
| ColorEnhancement |
string |
No |
Enable color enhancement for design and 3D application scenarios. Valid values:
|
off |
| SmoothEnhancement |
string |
No |
Enable smoothness enhancement for daily office scenarios. Valid values:
|
off |
| QualityEnhancement |
string |
No |
Enable image quality enhancement for design and 3D application scenarios. Valid values:
|
off |
| VideoEncPolicy |
string |
No |
Video encoding policy. Valid values:
|
qualityFirst |
| TargetFps |
integer |
No |
Target frame rate. Valid values: 10 to 60. |
30 |
| VideoEncMinQP |
integer |
No |
Minimum QP for video encoding, representing the highest quality. Valid values: 0 to 51. |
30 |
| VideoEncMaxQP |
integer |
No |
Maximum QP for video encoding, representing the lowest image quality. Valid values: 0 to 51. |
30 |
| VideoEncAvgKbps |
integer |
No |
Average video encoding bitrate. Unit: Kbps. Valid values: 1000 to 50000. |
2000 |
| VideoEncPeakKbps |
integer |
No |
Peak video encoding bitrate. Unit: Kbps. Valid values: 1000 to 50000. |
2000 |
| MaxReconnectTime |
integer |
No |
Maximum reconnection retry time when a cloud desktop disconnects due to objective reasons. Valid values: 30 to 7200. Unit: seconds. |
120 |
| WyAssistant |
string |
No |
Provide an entry point for Wuying AI Assistant in the floating ball on the cloud desktop when connecting through desktop clients (including Windows and macOS clients). Note
This feature applies only to desktop clients V7.7 or later. Valid values:
|
on |
| CpuProcessors |
array |
No |
The name of the process. |
|
|
string |
No |
Process name. |
notepad.exe |
|
| MemoryProcessors |
array |
No |
Process names. |
|
|
string |
No |
Process name. |
chrome.exe |
|
| DomainResolveRule |
array<object> |
No |
Domain name resolution policy. |
|
|
object |
No |
Details of the domain name resolution policy. |
||
| Domain |
string |
No |
Domain name. |
*.example.com |
| Policy |
string |
No |
Resolution policy. Valid values:
|
allow |
| Description |
string |
No |
Policy description. |
测试规则 |
| NetRedirectRule |
array<object> |
No |
Network redirection policy details. Note
This feature is in invitational preview and is not publicly available. |
|
|
object |
No |
Network redirection policy details. Note
This feature is in invitational preview and is not publicly available. |
||
| Domain |
string |
No |
Domain name. |
*.example.com |
| RuleType |
string |
No |
Rule type. Valid values:
|
domain |
| Policy |
string |
No |
Redirection policy. |
allow |
| ScopeValue |
array |
No |
Specify this parameter when |
|
|
string |
No |
Effective CIDR block range. |
47.100.XX.XX/24 |
|
| ClientType |
array<object> |
No |
List of logon method control rules. These rules control which clients can access cloud desktops. |
|
|
object |
No |
Logon method control rule. |
||
| Status |
string |
No |
Logon method control. Specify whether to allow users to log on to cloud desktops using a specific type of client. Note
If you do not configure parameters related to Valid values:
|
off |
| ClientType |
string |
No |
Logon method control. Specify the client type. Valid values:
|
windows |
| UsbSupplyRedirectRule |
array<object> |
No |
USB redirection rules. |
|
|
object |
No |
USB redirection rules. |
||
| VendorId |
string |
No |
Vendor ID. For more information, see Valid USB Vendor IDs (VIDs). |
04** |
| UsbRuleType |
string |
No |
USB redirection rule type. Valid values:
|
2 |
| Description |
string |
No |
Rule description. |
测试规则 |
| UsbRedirectType |
string |
No |
USB redirection type. Valid values:
|
1 |
| ProductId |
string |
No |
Product ID. |
08** |
| AuthorizeSecurityPolicyRule |
array<object> |
No |
List of security group control rules. |
|
|
object |
No |
List of security group control rules. |
||
| Type |
string |
No |
Direction of the security group control rule. Valid values:
|
inflow |
| Policy |
string |
No |
Authorization policy of the security group control rule. Valid values:
|
accept |
| PortRange |
string |
No |
Port range of the security group control rule. The port range depends on the protocol (IpProtocol):
For common ports used by typical applications, see Common ports. |
22/22 |
| Description |
string |
No |
Description of the security group control rule. |
test |
| IpProtocol |
string |
No |
Protocol type of the security group control rule. Valid values:
|
TCP |
| Priority |
string |
No |
Priority of the security group control rule. A smaller number indicates a higher priority. |
1 |
| CidrIp |
string |
No |
Object of the security group control rule. IPv4 CIDR block. |
10.0.XX.XX/8 |
| AuthorizeAccessPolicyRule |
array<object> |
No |
Client IP address whitelist. After this parameter is configured, only IP addresses within the specified CIDR blocks can access cloud desktops. |
|
|
object |
No |
Client IP address whitelist. |
||
| Description |
string |
No |
Description of the client IP address whitelist. |
test |
| CidrIp |
string |
No |
Client access IP address range. IPv4 CIDR block. |
47.100.XX.XX/16 |
| DeviceRedirects |
array<object> |
No |
List of device redirection rules. |
|
|
object |
No |
List of device redirection rules. |
||
| RedirectType |
string |
No |
Redirection type. Valid values:
|
usbRedirect |
| DeviceType |
string |
No |
Device type Valid values:
|
camera |
| DeviceRules |
array<object> |
No |
List of custom peripheral rules. |
|
|
object |
No |
List of custom peripheral rules. |
||
| DeviceName |
string |
No |
Device name. |
sandisk |
| RedirectType |
string |
No |
Redirection type. Valid values:
|
usbRedirect |
| DeviceType |
string |
No |
Peripheral type. Valid values:
|
storage |
| OptCommand |
string |
No |
Link optimization command. |
2:0 |
| DevicePid |
string |
No |
Product ID. |
0x55b1 |
| DeviceVid |
string |
No |
Vendor ID. For more information, see Valid USB Vendor IDs (VIDs). |
0x0781 |
| Platforms |
string |
No |
||
| WatermarkAntiCam |
string |
No |
Blind watermark anti-photo feature. Valid values:
|
off |
| WatermarkPower |
string |
No |
Blind watermark enhancement feature. Valid values:
|
medium |
| DomainResolveRuleType |
string |
No |
Domain name resolution policy type. Valid values:
|
off |
| ClipboardScope |
string |
No |
Clipboard scope |
GLOBAL |
| ClipboardGraineds |
array<object> |
No |
Fine-grained clipboard control configuration |
|
|
object |
No |
|||
| GrainedType |
string |
No |
||
| ClipboardType |
string |
No |
||
| ClipboardSize |
integer |
No |
||
| ClipboardSizeUnit |
string |
No |
||
| InClipboardSize |
integer |
No |
||
| InClipboardSizeUnit |
string |
No |
||
| OutClipboardSize |
integer |
No |
||
| OutClipboardSizeUnit |
string |
No |
||
| StatusMonitor |
string |
No |
Provide an entry point for status monitoring in the floating ball on the cloud desktop. Valid values:
|
off |
| MobileRestart |
string |
No |
Provide a restart button in the floating ball on the cloud desktop when connecting through mobile clients (Android and iOS clients). Note
This feature applies only to mobile clients V7.4 or later. Valid values:
|
off |
| MobileShutdown |
string |
No |
Provide a shutdown button in the floating ball on the cloud desktop when connecting through mobile clients (Android and iOS clients). Note
This feature applies only to mobile clients V7.4 or later. Valid values:
|
off |
| ResolutionModel |
string |
No |
Resolution type. Valid values:
|
adaptive |
| ResolutionWidth |
integer |
No |
Resolution width. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 640 to 4096. |
720 |
| ResolutionHeight |
integer |
No |
Resolution height. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 480 to 4096. |
1280 |
| Taskbar |
string |
No |
Application taskbar. Note
This parameter applies only to cloud application policies. Valid values:
|
off |
| NoOperationDisconnect |
string |
No |
Disconnect on inactivity. Note
This parameter applies only to cloud application policies. Valid values:
|
off |
| NoOperationDisconnectTime |
integer |
No |
Inactivity disconnect duration. Valid values: 120 to 7200. Unit: seconds. Note
This parameter applies only to cloud application policies. |
120 |
| DisconnectKeepSession |
string |
No |
Session retention after disconnection. Note
This parameter applies only to cloud application policies. Valid values:
|
customTime |
| DisconnectKeepSessionTime |
integer |
No |
Session retention duration after disconnection. Valid values: 30 to 7200. Unit: seconds. Note
This parameter applies only to cloud application policies. |
30 |
| RecordEvents |
array |
No |
List of screen recording events. |
|
|
string |
No |
Screen recording event. Valid values:
|
transferWithLocal |
|
| RecordEventFilePaths |
array |
No |
Absolute paths of files to monitor in screen recording audit. |
|
|
string |
No |
Absolute path of the file to monitor in screen recording audit. |
C://test.txt |
|
| RecordEventRegisters |
array |
No |
Absolute paths of registry keys to monitor in screen recording audit. |
|
|
string |
No |
Absolute path of the registry key to monitor in screen recording audit. |
计算机\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\USBSTOR |
|
| RecordEventDuration |
integer |
No |
Duration of screen recording after an event is detected in screen recording audit. Unit: minutes. Valid values: 10 to 60. |
10 |
| ResetDesktop |
string |
No |
Reset cloud desktop. |
off |
| DeviceConnectHint |
string |
No |
Peripheral connection hint control. |
off |
| FileMigrate |
string |
No |
File migration. |
off |
| WuyingKeeper |
string |
No |
Wuying Keeper switch. |
off |
| InternetPrinter |
string |
No |
||
| SafeMenu |
string |
No |
||
| ScreenDisplayMode |
string |
No |
||
| ClientControlMenu |
string |
No |
||
| FileTransferSpeedLocation |
string |
No |
||
| FileTransferSpeed |
string |
No |
||
| FileTransferAddress |
string |
No |
||
| CpdDriveClipboard |
string |
No |
||
| UseTime |
string |
No |
||
| AutoReconnect |
string |
No |
Client auto-reconnect switch |
off |
| MobileWuyingKeeper |
string |
No |
Mobile Wuying Keeper switch |
off |
| MobileSafeMenu |
string |
No |
Mobile Windows security control switch |
off |
| MobileWyAssistant |
string |
No |
Mobile Xiao Ying switch |
off |
| RecordEventLevels |
array<object> |
No |
Levels of screen recording events |
|
|
object |
No |
|||
| EventType |
string |
No |
Event type |
StartApplication |
| EventLevel |
string |
No |
Event level |
HIGH |
| RecordEventFileExts |
array |
No |
File name extensions for screen recording events |
|
|
string |
No |
txt |
||
| ExternalDrive |
string |
No |
||
| WatermarkShadow |
string |
No |
||
| ClientCreateSnapshot |
string |
No |
||
| AcademicProxy |
string |
No |
||
| ModelLibrary |
string |
No |
||
| PortProxy |
string |
No |
||
| BusinessChannel |
string |
No |
||
| DiskOverload |
string |
No |
||
| CpuOverload |
string |
No |
||
| MemoryOverload |
string |
No |
||
| ResolutionDpi |
integer |
No |
||
| HoverConfigMsg |
string |
No |
||
| MultiScreen |
string |
No |
||
| KeyboardControl |
string |
No |
||
| AdminKeyboardOnWindows |
string |
No |
||
| AdminKeyboardOnFullScreen |
string |
No |
||
| Description |
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| PolicyGroupId |
string |
Cloud desktop policy ID. |
pg-gx2x1dhsmthe9**** |
| RequestId |
string |
Request ID. |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
Examples
Success response
JSON format
{
"PolicyGroupId": "pg-gx2x1dhsmthe9****",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.