Describes details of cloud desktop policies.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecd:DescribePolicyGroups |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
Region ID. Call DescribeRegions to list regions supported by WUYING Workspace. |
cn-hangzhou |
| MaxResults |
integer |
No |
Number of entries per page for paged queries.
|
10 |
| NextToken |
string |
No |
Pagination token. Set this parameter to the value of NextToken returned by the previous call. Do not set this parameter for the first call. |
caeba0bbb2be03f84eb48b699f0a4883 |
| PolicyGroupId |
array |
No |
List of cloud desktop policy IDs. |
system-all-enabled-policy |
|
string |
No |
Cloud desktop policy ID. |
system-all-enabled-policy |
|
| Scope |
string |
No |
Scope where the cloud desktop policy takes effect. Valid values:
|
GLOBAL |
| ExternalPolicyGroupIds |
array |
No |
List of cloud desktop policy IDs to exclude from the response. |
|
|
string |
No |
Cloud desktop policy ID to exclude from the response. |
pg-0cid8v30p16k4**** |
|
| PageNumber |
integer |
No |
||
| PageSize |
integer |
No |
||
| BusinessChannel |
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response object. |
||
| NextToken |
string |
Token for the next query. If NextToken is empty, no more results are available. |
caeba0bbb2be03f84eb48b699f0a**** |
| RequestId |
string |
Request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| Count |
integer |
||
| PageNumber |
integer |
||
| PageSize |
integer |
||
| DescribePolicyGroups |
array<object> |
Details of cloud desktop policies. |
|
|
array<object> |
Details of cloud desktop policies. |
||
| PolicyStatus |
string |
Status of the cloud desktop policy. Valid values:
|
AVAILABLE |
| Html5Access |
string |
Web client access policy. Valid values:
|
off |
| WatermarkType |
string |
Watermark type. Valid values:
|
EndUserId |
| PreemptLogin |
string |
Cloud desktop preemption policy. Note
To protect end-user experience and data security, users cannot preempt each other's cloud desktops. This setting defaults to Valid values:
|
off |
| WatermarkCustomText |
string |
If you set |
custom-watermark |
| Clipboard |
string |
Clipboard permission. Valid values:
|
off |
| PolicyGroupId |
string |
Cloud desktop policy ID. |
pg-gx2x1dhsmthe9**** |
| PrinterRedirection |
string |
Printer redirection policy. Valid values:
|
on |
| WatermarkTransparency |
string |
Watermark opacity level. Valid values:
|
LIGHT |
| Html5FileTransfer |
string |
Web client file transfer policy. Valid values:
|
off |
| UsbRedirect |
string |
USB redirection. Valid values:
|
on |
| PolicyGroupType |
string |
Type of cloud desktop policy. Valid values:
|
SYSTEM |
| Watermark |
string |
Watermark. Valid values:
|
on |
| VisualQuality |
string |
Image display quality policy. Valid values:
|
medium |
| EdsCount |
integer |
Total number of cloud desktops and cloud desktop pools associated with this policy. Only custom policies return this value. |
2 |
| Name |
string |
Name of the cloud desktop policy. |
testPolicyGroupName |
| LocalDrive |
string |
Local disk mapping permission. Valid values:
|
readwrite |
| AuthorizeSecurityPolicyRules |
array<object> |
List of security group rules. |
|
|
object |
A list of security group control rules. |
||
| Type |
string |
Rule direction. Valid values:
|
inflow |
| Policy |
string |
Authorization policy. Valid values:
|
accept |
| Description |
string |
Description of the security group rule. |
test |
| PortRange |
string |
Port range for the security group rule. |
22/22 |
| IpProtocol |
string |
Protocol type for the security group rule. Valid values:
|
tcp |
| Priority |
string |
Rule priority. Lower numbers indicate higher priority. |
1 |
| CidrIp |
string |
Target CIDR block for the security group rule. |
47.100.XX.XX/16 |
| AuthorizeAccessPolicyRules |
array<object> |
List of client IP address whitelists. Only clients in these CIDR blocks can access cloud desktops. |
|
|
object |
Client IP address whitelist. |
||
| Description |
string |
Description of the client IP address range. |
test |
| CidrIp |
string |
Client IP address range in CIDR notation. |
47.100.XX.XX/16 |
| ClientTypes |
array<object> |
List of client access controls. Specifies which client types can connect to cloud desktops. |
|
|
object |
Client access control rule. |
||
| Status |
string |
Whether a client type can connect to cloud desktops. Valid values:
|
ON |
| ClientType |
string |
Client type. Valid values:
|
windows |
| PreemptLoginUsers |
array |
List of usernames allowed to preempt cloud desktops. |
|
|
string |
Username of a user allowed to preempt cloud desktops. |
Alice |
|
| GpuAcceleration |
string |
Enable graphics acceleration for GPU-based cloud desktops. Enable this for high-performance use cases such as professional design. Valid values:
|
off |
| UsbSupplyRedirectRule |
array<object> |
USB redirection rules. |
|
|
object |
USB redirection rule. |
||
| VendorId |
string |
Vendor ID. See Valid USB Vendor IDs (VIDs). |
04** |
| ProductId |
string |
Product ID. |
08** |
| Description |
string |
Rule description. |
测试规则 |
| UsbRedirectType |
integer |
USB redirection type. Valid values:
|
1 |
| DeviceClass |
string |
Device class. Required when |
0Eh |
| DeviceSubclass |
string |
Device subclass. Required when |
xxh |
| UsbRuleType |
integer |
USB redirection rule type. Valid values:
|
1 |
| DomainResolveRuleType |
string |
Domain name resolution policy switch. Valid values:
|
on |
| DomainResolveRule |
array<object> |
List of domain name resolution rules. |
|
|
object |
Domain name resolution rule. |
||
| Domain |
string |
Domain name. |
*.example.com |
| Policy |
string |
Resolution policy. Valid values:
|
allow |
| Description |
string |
Rule description. |
测试规则 |
| NetRedirectRule |
array<object> |
List of network redirection rules. Note
This feature is in invitational preview and not publicly available. |
|
|
object |
Network redirection rule. Note
This feature is in invitational preview and not publicly available. |
||
| Domain |
string |
Rule content. |
*.example.com |
| RuleType |
string |
Rule type. Valid values:
|
domain |
| Policy |
string |
Rule type. Valid values:
|
allow |
| Recording |
string |
Enable screen recording. Valid values:
|
OFF |
| RecordingStartTime |
string |
Start time for recording. Format: HH:MM:SS. Only used when Recording is set to PERIOD. |
08:00:00 |
| RecordingEndTime |
string |
End time for recording. Format: HH:MM:SS. Only used when Recording is set to PERIOD. |
08:59:00 |
| RecordingFps |
integer |
Recording frame rate. Unit: FPS (frames per second). Valid values:
|
5 |
| RecordingExpires |
integer |
Retention period for recording files. Valid values: 1–180 days. |
15 |
| CameraRedirect |
string |
Enable camera redirection. Valid values:
|
on |
| NetRedirect |
string |
Enable network redirection. Note
This feature is in invitational preview and not publicly available. Valid values:
|
off |
| AppContentProtection |
string |
Enable anti-screenshot protection. Valid values:
|
off |
| RecordContent |
string |
Enable custom screen recording. Valid values:
|
off |
| RecordContentExpires |
integer |
Expiration time for custom recordings. Default: 30 days. |
30 |
| RemoteCoordinate |
string |
Remote assistance mouse and keyboard control permission. Valid values:
|
fullControl |
| RecordingDuration |
integer |
Playback duration for recording files, in minutes. Files automatically split and upload based on this setting. Files roll over after reaching 300 MB. Valid values:
|
10 |
| Scope |
string |
Policy scope. Valid values:
|
GLOBAL |
| ScopeValue |
array |
Required when |
|
|
string |
Effective CIDR block. |
47.100.XX.XX/24 |
|
| RecordingAudio |
string |
Record audio from the cloud desktop. Valid values:
|
on |
| InternetCommunicationProtocol |
string |
Network communication protocol. Valid values:
|
BOTH |
| VideoRedirect |
string |
Media redirection. Valid values:
|
off |
| WatermarkTransparencyValue |
integer |
Watermark transparency. Higher values mean lower transparency. Valid range: 10–100. |
10 |
| WatermarkColor |
integer |
Watermark font color. Valid range: 0–16777215. |
0 |
| WatermarkFontSize |
integer |
Watermark font size. Valid range: 10–20. |
10 |
| WatermarkFontStyle |
string |
Watermark font style. Valid values:
|
plain |
| WatermarkDegree |
number |
Watermark tilt angle. Valid range: -10 to -30. |
-10 |
| WatermarkRowAmount |
integer |
Number of watermark rows. Note
This parameter is not yet available. |
5 |
| EndUserApplyAdminCoordinate |
string |
Enable end users to request administrator assistance. Valid values:
|
on |
| EndUserGroupCoordinate |
string |
Enable collaborative streaming between end users. Valid values:
|
on |
| CpuProtectedMode |
string |
Enable CPU protection mode. Valid values:
|
on |
| CpuRateLimit |
integer |
Overall CPU usage limit, as a percentage. Valid range: 70–90. |
70 |
| CpuSampleDuration |
integer |
Overall CPU sampling duration, in seconds. Valid range: 10–60. |
10 |
| CpuSingleRateLimit |
integer |
Per-core CPU usage limit, as a percentage. Valid range: 70–100. |
70 |
| CpuDownGradeDuration |
integer |
CPU downgrade duration, in seconds. Valid range: 30–120. |
30 |
| CpuProcessors |
array |
Whitelist of processes exempt from CPU usage limits. |
|
|
string |
Process name. |
chrome.exe |
|
| MemoryProtectedMode |
string |
Enable memory protection mode. Valid values:
|
on |
| MemoryRateLimit |
integer |
Overall memory usage limit, as a percentage. Valid range: 70–90. |
70 |
| MemorySampleDuration |
integer |
Overall memory sampling duration, in seconds. Valid range: 30–60. |
30 |
| MemorySingleRateLimit |
integer |
Memory usage percentage for a single process. Valid range: 30–60. |
30 |
| MemoryDownGradeDuration |
integer |
Memory downgrade duration for a single process, in seconds. Valid range: 30–120. |
30 |
| MemoryProcessors |
array |
Whitelist of processes exempt from memory usage limits. |
|
|
string |
Process name. |
notepad.exe |
|
| WatermarkSecurity |
string |
Blind watermark security priority rule. Valid values:
|
on |
| WatermarkAntiCam |
string |
Blind watermark anti-camera feature. Valid values:
|
off |
| WatermarkPower |
string |
Blind watermark Enhanced function plan. Valid values:
|
medium |
| RecordingUserNotify |
string |
Recording client message notification feature. Valid values:
|
off |
| RecordingUserNotifyMessage |
string |
Recording client notification content. No need to specify by default. |
您的云电脑正在被录屏 |
| AdminAccess |
string |
Whether users have administrative permission after connecting to the cloud desktop. Note
This feature is in invitational preview and not publicly available. |
deny |
| MaxReconnectTime |
integer |
Maximum reconnection retry time for cloud desktops disconnected due to objective reasons. Valid range: 30–7200, in seconds. |
120 |
| DisplayMode |
string |
Display mode. Valid values:
|
adminCustom |
| StreamingMode |
string |
Streaming mode adaptation scenario. Valid values:
|
smooth |
| ColorEnhancement |
string |
Enable color enhancement for design and 3D application scenarios. Valid values:
|
off |
| SmoothEnhancement |
string |
Enable smoothness enhancement for daily office scenarios. Valid values:
|
off |
| QualityEnhancement |
string |
Enable quality enhancement for design and 3D application scenarios. Valid values:
|
off |
| VideoEncPolicy |
string |
Video encoding policy. Valid values:
|
qualityFirst |
| TargetFps |
integer |
Target frame rate. Valid range: 10–60. |
30 |
| VideoEncMinQP |
integer |
Minimum QP for video encoding (highest quality). Valid range: 0–51. |
20 |
| VideoEncMaxQP |
integer |
Maximum QP for video encoding (lowest quality). Valid range: 0–51. |
20 |
| VideoEncAvgKbps |
integer |
Average bitrate for video encoding. Valid range: 1000–50000. |
1000 |
| VideoEncPeakKbps |
integer |
Peak bitrate for video encoding. Valid range: 1000–50000. |
1000 |
| DeviceRedirects |
array<object> |
List of device redirection rules. |
|
|
object |
Device redirection rule. |
||
| DeviceType |
string |
Peripheral type. Valid values:
|
camera |
| RedirectType |
string |
Redirection type. Valid values:
|
usbRedirect |
| DeviceRules |
array<object> |
List of custom peripheral rules. |
|
|
object |
Custom peripheral rule. |
||
| DeviceType |
string |
Peripheral type. Valid values:
|
storage |
| DeviceName |
string |
Device name |
sandisk |
| DeviceVid |
string |
Vendor ID. See Valid USB Vendor IDs (VIDs). |
0x0781 |
| DevicePid |
string |
Product ID. |
0x55b1 |
| RedirectType |
string |
Redirection type. Valid values:
|
usbRedirect |
| OptCommand |
string |
Link optimization instruction. |
2:0 |
| Platforms |
string |
||
| WyAssistant |
string |
Indicates whether the Cloud Desktop floating ball provides access to the RDS Copilot feature. Valid values:
|
on |
| ResourceRegionId |
string |
Region of the cloud desktop policy. Note
If it is a region-less policy, the value is |
center |
| DomainList |
string |
Access domain name control. Domain names support wildcard characters (*). Separate multiple domain names with commas. Valid values:
|
off |
| StatusMonitor |
string |
Whether to provide the status monitoring feature entry in the cloud desktop floating ball. Valid values:
|
on |
| MobileRestart |
string |
Whether to provide a restart button in the cloud desktop floating ball when connecting to a cloud desktop via a mobile client (Android or iOS). Note
Only applies to mobile clients V7.4 or later. Valid values:
|
off |
| MobileShutdown |
string |
Whether to provide a shutdown button in the cloud desktop floating ball when connecting to a cloud desktop via a mobile client (Android or iOS). Note
Only applies to mobile clients V7.4 or later. Valid values:
|
off |
| DesktopCount |
integer |
Number of cloud desktops associated with this policy. |
1 |
| DesktopGroupCount |
integer |
Number of cloud desktop pools associated with this policy. |
1 |
| ResourceGroupCount |
integer |
Number of resource groups associated with this policy. |
1 |
| RecordEventFilePaths |
array |
List of absolute paths for file monitoring in recording audit. |
|
|
string |
Absolute path for file monitoring in recording audit. |
d:/data |
|
| RecordEventRegisters |
array |
List of absolute paths for registry monitoring in recording audit. |
|
|
string |
Absolute path for registry monitoring in recording audit. |
计算机\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\USBSTOR |
|
| RecordEventDuration |
integer |
Recording duration after an event is detected in recording audit, in minutes. Valid range: 10–60. |
10 |
| ResetDesktop |
string |
Reset cloud desktop. |
null |
| FileTransfer |
string |
File transfer. |
null |
| DeviceConnectHint |
string |
||
| ResolutionModel |
string |
||
| ResolutionWidth |
integer |
||
| ResolutionHeight |
integer |
||
| FileMigrate |
string |
||
| WuyingKeeper |
string |
||
| InternetPrinter |
string |
||
| SafeMenu |
string |
||
| ScreenDisplayMode |
string |
||
| ClientControlMenu |
string |
||
| FileTransferSpeedLocation |
string |
||
| FileTransferAddress |
string |
||
| FileTransferSpeed |
string |
||
| CpdDriveClipboard |
string |
||
| UseTime |
string |
||
| AutoReconnect |
string |
Client auto-reconnect configuration item |
off |
| MobileWuyingKeeper |
string |
Mobile WUYING Keeper switch |
off |
| MobileSafeMenu |
string |
Mobile Windows security control switch |
off |
| MobileWyAssistant |
string |
Mobile WUYING Assistant switch |
off |
| ExternalDrive |
string |
||
| ClientCreateSnapshot |
string |
||
| WatermarkShadow |
string |
||
| AcademicProxy |
string |
||
| ModelLibrary |
string |
||
| PortProxy |
string |
||
| DiskOverload |
string |
||
| CpuOverload |
string |
||
| MemoryOverload |
string |
||
| ResolutionDpi |
integer |
||
| HoverConfigMsg |
string |
||
| MultiScreen |
string |
||
| HoverShutdown |
string |
||
| HoverRestart |
string |
||
| HoverHibernate |
string |
||
| ClientShutdown |
string |
||
| ClientRestart |
string |
||
| ClientHibernate |
string |
||
| RecordEventLevels |
array<object> |
Recording event level switch |
|
|
object |
|||
| EventType |
string |
Event type |
|
| EventLevel |
string |
Event level |
|
| RecordEventFileExts |
array |
Recording event file extensions |
|
|
string |
Examples
Success response
JSON format
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"Count": 0,
"PageNumber": 0,
"PageSize": 0,
"DescribePolicyGroups": [
{
"PolicyStatus": "AVAILABLE",
"Html5Access": "off",
"WatermarkType": "EndUserId",
"PreemptLogin": "off",
"WatermarkCustomText": "custom-watermark",
"Clipboard": "off",
"PolicyGroupId": "pg-gx2x1dhsmthe9****",
"PrinterRedirection": "on",
"WatermarkTransparency": "LIGHT",
"Html5FileTransfer": "off",
"UsbRedirect": "on",
"PolicyGroupType": "SYSTEM",
"Watermark": "on",
"VisualQuality": "medium",
"EdsCount": 2,
"Name": "testPolicyGroupName",
"LocalDrive": "readwrite",
"AuthorizeSecurityPolicyRules": [
{
"Type": "inflow",
"Policy": "accept",
"Description": "test",
"PortRange": "22/22",
"IpProtocol": "tcp",
"Priority": "1",
"CidrIp": "47.100.XX.XX/16"
}
],
"AuthorizeAccessPolicyRules": [
{
"Description": "test",
"CidrIp": "47.100.XX.XX/16"
}
],
"ClientTypes": [
{
"Status": "ON",
"ClientType": "windows"
}
],
"PreemptLoginUsers": [
"Alice"
],
"GpuAcceleration": "off",
"UsbSupplyRedirectRule": [
{
"VendorId": "04**",
"ProductId": "08**",
"Description": "测试规则",
"UsbRedirectType": 1,
"DeviceClass": "0Eh",
"DeviceSubclass": "xxh",
"UsbRuleType": 1
}
],
"DomainResolveRuleType": "on",
"DomainResolveRule": [
{
"Domain": "*.example.com",
"Policy": "allow",
"Description": "测试规则"
}
],
"NetRedirectRule": [
{
"Domain": "*.example.com",
"RuleType": "domain",
"Policy": "allow"
}
],
"Recording": "OFF",
"RecordingStartTime": "08:00:00",
"RecordingEndTime": "08:59:00",
"RecordingFps": 5,
"RecordingExpires": 15,
"CameraRedirect": "on",
"NetRedirect": "off",
"AppContentProtection": "off",
"RecordContent": "off",
"RecordContentExpires": 30,
"RemoteCoordinate": "fullControl",
"RecordingDuration": 10,
"Scope": "GLOBAL",
"ScopeValue": [
"47.100.XX.XX/24"
],
"RecordingAudio": "on",
"InternetCommunicationProtocol": "BOTH",
"VideoRedirect": "off",
"WatermarkTransparencyValue": 10,
"WatermarkColor": 0,
"WatermarkFontSize": 10,
"WatermarkFontStyle": "plain",
"WatermarkDegree": -10,
"WatermarkRowAmount": 5,
"EndUserApplyAdminCoordinate": "on",
"EndUserGroupCoordinate": "on",
"CpuProtectedMode": "on",
"CpuRateLimit": 70,
"CpuSampleDuration": 10,
"CpuSingleRateLimit": 70,
"CpuDownGradeDuration": 30,
"CpuProcessors": [
"chrome.exe"
],
"MemoryProtectedMode": "on",
"MemoryRateLimit": 70,
"MemorySampleDuration": 30,
"MemorySingleRateLimit": 30,
"MemoryDownGradeDuration": 30,
"MemoryProcessors": [
"notepad.exe"
],
"WatermarkSecurity": "on",
"WatermarkAntiCam": "off",
"WatermarkPower": "medium",
"RecordingUserNotify": "off",
"RecordingUserNotifyMessage": "您的云电脑正在被录屏",
"AdminAccess": "deny",
"MaxReconnectTime": 120,
"DisplayMode": "adminCustom",
"StreamingMode": "smooth",
"ColorEnhancement": "off",
"SmoothEnhancement": "off",
"QualityEnhancement": "off",
"VideoEncPolicy": "qualityFirst",
"TargetFps": 30,
"VideoEncMinQP": 20,
"VideoEncMaxQP": 20,
"VideoEncAvgKbps": 1000,
"VideoEncPeakKbps": 1000,
"DeviceRedirects": [
{
"DeviceType": "camera",
"RedirectType": "usbRedirect"
}
],
"DeviceRules": [
{
"DeviceType": "storage",
"DeviceName": "sandisk",
"DeviceVid": "0x0781",
"DevicePid": "0x55b1",
"RedirectType": "usbRedirect",
"OptCommand": "2:0",
"Platforms": ""
}
],
"WyAssistant": "on",
"ResourceRegionId": "center",
"DomainList": "off",
"StatusMonitor": "on",
"MobileRestart": "off",
"MobileShutdown": "off",
"DesktopCount": 1,
"DesktopGroupCount": 1,
"ResourceGroupCount": 1,
"RecordEventFilePaths": [
"d:/data"
],
"RecordEventRegisters": [
"计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR"
],
"RecordEventDuration": 10,
"ResetDesktop": "null",
"FileTransfer": "null",
"DeviceConnectHint": "",
"ResolutionModel": "",
"ResolutionWidth": 0,
"ResolutionHeight": 0,
"FileMigrate": "",
"WuyingKeeper": "",
"InternetPrinter": "",
"SafeMenu": "",
"ScreenDisplayMode": "",
"ClientControlMenu": "",
"FileTransferSpeedLocation": "",
"FileTransferAddress": "",
"FileTransferSpeed": "",
"CpdDriveClipboard": "",
"UseTime": "",
"AutoReconnect": "off",
"MobileWuyingKeeper": "off",
"MobileSafeMenu": "off",
"MobileWyAssistant": "off",
"ExternalDrive": "",
"ClientCreateSnapshot": "",
"WatermarkShadow": "",
"AcademicProxy": "",
"ModelLibrary": "",
"PortProxy": "",
"DiskOverload": "",
"CpuOverload": "",
"MemoryOverload": "",
"ResolutionDpi": 0,
"HoverConfigMsg": "",
"MultiScreen": "",
"HoverShutdown": "",
"HoverRestart": "",
"HoverHibernate": "",
"ClientShutdown": "",
"ClientRestart": "",
"ClientHibernate": "",
"RecordEventLevels": [
{
"EventType": "",
"EventLevel": ""
}
],
"RecordEventFileExts": [
""
]
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.