DocsICP FilingConsole
Documentation

DescribePolicyGroups

Updated at:
Copy as MD
Product
My Favorites

Queries the details of cloud desktop policies.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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

The region ID. You can call the DescribeRegions operation to query the list of regions supported by Wuying Workspace.

cn-hangzhou
MaxResults

integer

No

The number of entries to return per page when paging in a paged query.

  • Maximum value: 100.

  • Default value: 10.

10
NextToken

string

No

The query token. Set the value to the NextToken value returned from the last call to this operation. You do not need to specify this parameter for the first call.

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupId

array

No

The IDs of the cloud desktop policies.

system-all-enabled-policy

string

No

The ID of the cloud desktop policy.

system-all-enabled-policy
Scope

string

No

The effective scope of the cloud desktop policies.

Valid values:

  • ALL :

    All policies.

  • IP :

    IP-based.

  • GLOBAL :

    Global [default value].

GLOBAL
ExternalPolicyGroupIds

array

No

The IDs of the cloud desktop policies to exclude from the query results.

string

No

The ID of the cloud desktop policy to exclude from the query results.

pg-0cid8v30p16k4****
PageNumber

integer

No

The current page number when paging in a paged query.

1
PageSize

integer

No

The maximum number of entries to return per page when paging in a paged query.
Default value: 20.

20
BusinessChannel

string

No

The business channel. Valid values:

  • Enterprise: Enterprise Edition.

  • Business: Business Edition.

Enterprise

Response elements

Element

Type

Description

Example

object

The response information collection.

Count

integer

The count.

40
DescribePolicyGroups

array<object>

The details of the cloud computer policies.

array<object>

The details of the cloud computer policies.

AcademicProxy

string

Specifies whether to enable the academic proxy feature. Valid values:

  • on: Enabled.

  • off: Disabled.

off
AdminAccess

string

Specifies whether users have administrator permissions after connecting to a cloud computer.

Note

This feature is in closed beta and is not publicly available.

deny
AdminKeyboardOnFullScreen

string

Specifies whether to enable administrator keyboard control in full-screen mode. Valid values:

  • on: Enabled.

  • off: Disabled.

off
AdminKeyboardOnWindows

string

Specifies whether to enable administrator keyboard control in Windows. Valid values:

  • on: Enabled.

  • off: Disabled.

off
AppContentProtection

string

Specifies whether to enable the screen capture prevention feature.

Valid values:

  • off :

    Disabled [default value]

  • on :

    Enabled.

off
AppScreenshotBuckets

array<object>

The list of custom Object Storage Service (OSS) buckets for mobile screenshots with screen capture prevention.

object

The custom OSS bucket for mobile screenshots with screen capture prevention.

BucketName

string

The bucket name.

my-bucket
BucketRegionId

string

The region where the user's OSS bucket is located. It must match the actual region of the bucket.

cn-hangzhou
AuthorizeAccessPolicyRules

array<object>

The list of client IP address whitelists. Only IP addresses in the whitelisted CIDR blocks can access the cloud computer.

object

The client access IP address whitelist.

CidrIp

string

The client access IP address CIDR block. The value must be an IPv4 CIDR block.

47.100.XX.XX/16
Description

string

The description of the client access IP address CIDR block.

Corporate office network
AuthorizeSecurityPolicyRules

array<object>

The list of security group control rules.

object

The list of security group control rules.

CidrIp

string

The target of the security group control rule. The value must be an IPv4 CIDR block.

47.100.XX.XX/16
Description

string

The description of the security group control rule.

Allow access to the internal R&D environment
IpProtocol

string

The protocol type of the security group control rule.

Valid values:

  • tcp :

    TCP.

  • udp :

    UDP.

  • all :

    All protocols.

  • gre :

    GRE.

  • icmp :

    ICMP (IPv4)

tcp
Policy

string

The authorization policy of the security group control rule.

Valid values:

  • drop :

    Drop. Denies all access requests.

  • accept :

    Accept. Allows all access requests.

accept
PortRange

string

The port range of the security group control rule.

22/22
Priority

string

The priority of the security group control rule. A smaller value indicates a higher priority.

1
Type

string

The direction of the security group control rule.

Valid values:

  • outflow :

    Outbound.

  • inflow :

    Inbound.

inflow
AutoReconnect

string

The client auto-reconnect configuration.

off
AutoSaveAppScreenshot

string

Specifies whether to automatically save mobile screenshots. Valid values:

  • on: Enabled.

  • off: Disabled.

off
CameraRedirect

string

Specifies whether to enable local camera redirection.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled [default value]

on
ClientControlMenu

string

Specifies whether to display the client control menu. Valid values:

  • on: Enabled.

  • off: Disabled.

on
ClientCreateSnapshot

string

Specifies whether to enable the feature that allows clients to create custom snapshots. Valid values:

  • on: Enabled.

  • off: Disabled.

off
ClientHibernate

string

Specifies whether to display the hibernate option in the client menu. Valid values:

  • on: Enabled.

  • off: Disabled.

off
ClientRestart

string

Specifies whether to display the restart option in the client menu. Valid values:

  • on: Enabled.

  • off: Disabled.

off
ClientShutdown

string

Specifies whether to display the shutdown option in the client menu. Valid values:

  • on: Enabled.

  • off: Disabled.

off
ClientTypes

array<object>

The list of logon method control rules. This parameter specifies which clients can be used to access the cloud computer.

object

The logon method control rule.

ClientType

string

The client type.

Valid values:

  • html5 :

    Web client.

  • android :

    Android client.

  • windows :

    Windows client.

  • ios :

    iOS client.

  • macos :

    macOS client.

windows
Status

string

Specifies whether to allow a specific type of client to connect to the cloud computer.

Valid values:

  • OFF :

    Not allowed.

  • ON :

    Allowed.

ON
Clipboard

string

The clipboard permissions.

Valid values:

  • read :

    One-way allowed. You can perform content replication from the local device to the cloud computer, but not from the cloud computer to the local device.

  • readwrite :

    Two-way allowed. You can perform content replication between the local device and the cloud computer.

  • write :

    One-way allowed. You can perform content replication from the cloud computer to the local device, but not from the local device to the cloud computer.

  • off :

    Two-way disabled. You cannot copy content between the cloud computer and the local device. [default value]

off
ColorEnhancement

string

Specifies whether color enhancement is enabled for design and 3D common scenarios.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
CpdDriveClipboard

string

Specifies whether to enable the local drive clipboard feature. Valid values:

  • on: Enabled.

  • off: Disabled.

off
CpuDownGradeDuration

integer

The CPU downclocking duration. Valid values: 30 to 120. Unit: seconds.

30
CpuOverload

string

Specifies whether to enable CPU load protection. Valid values:

  • on: Enabled.

  • off: Disabled.

off
CpuProcessors

array

The whitelist of processes that are not restricted by the CPU usage limit.

string

The process name.

chrome.exe
CpuProtectedMode

string

Specifies whether to enable CPU protection mode.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
CpuRateLimit

integer

The overall CPU usage percentage. Valid values: 70 to 90.

70
CpuSampleDuration

integer

The overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.

10
CpuSingleRateLimit

integer

The single-core CPU usage percentage. Valid values: 70 to 100.

70
Description

string

The description of the NAS file system.

newDescription
DesktopCount

integer

The number of cloud computers associated with the policy.

1
DesktopGroupCount

integer

The number of cloud computer pools associated with the policy.

1
DeviceConnectHint

string

The peripheral connection prompt settings.

off
DeviceRedirects

array<object>

The list of device redirection rules.

object

The device redirection rule.

DeviceType

string

The peripheral type.

Valid values:

  • printer :

    Printer.

  • scanner :

    Scanner.

  • camera :

    Camera.

  • adb :

    Android device.

camera
RedirectType

string

The redirection type. Valid values:

  • usbRedirect: USB redirection.

  • deviceRedirect: Device redirection.

  • off: Disabled.

usbRedirect
DeviceRules

array<object>

The list of custom peripheral rules.

object

The custom peripheral rule.

DeviceName

string

The device name.

sandisk
DevicePid

string

The product ID.

0x55b1
DeviceType

string

The peripheral type.

Valid values:

  • usbKey :

    UKey

  • other :

    Other.

  • graphicsTablet :

    Graphics tablet.

  • printer :

    Printer.

  • cardReader :

    Card reader.

  • scanner :

    Scanner.

  • storage :

    Storage device.

  • camera :

    Camera.

  • adb :

    Android device.

  • networkInterfaceCard :

    Network interface card.

storage
DeviceVid

string

The vendor ID. For more information, see Valid USB Vendor IDs (VIDs).

0x0781
OptCommand

string

The link optimization command.

2:0
Platforms

string

The platform types to which the device rule applies.

Windows
RedirectType

string

The redirection type.

Valid values:

  • deviceRedirect :

    Device redirection.

  • usbRedirect :

    USB redirection.

  • off :

    Disabled.

usbRedirect
DiskOverload

string

The disk overload protection switch. Valid values:

  • on: Enabled.

  • off: Disabled.

off
DisplayMode

string

The display mode.

Valid values:

  • clientCustom :

    User-defined.

  • adminOffice :

    Daily office scenario.

  • adminDesign :

    3D common scenarios.

  • adminCustom :

    Administrator-defined parameters.

adminCustom
DomainList

string

The access control for domain names. Domain names support wildcards (*). Separate multiple domain names with commas (,).

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
DomainResolveRule

array<object>

The list of domain name resolution policies.

object

The details of the domain name resolution policy.

Description

string

The policy description.

Test rule
Domain

string

The domain name.

*.example.com
Policy

string

The resolution policy.

Valid values:

  • allow :

    Allow.

  • block :

    Block.

allow
DomainResolveRuleType

string

The domain name resolution policy switch.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
EdsCount

integer

The total number of cloud computers and cloud computer pools associated with the policy. This parameter is returned only for custom policies.

2
EndUserApplyAdminCoordinate

string

The switch for users to request administrator assistance.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
EndUserCount

string

The number of associated end users.

3
EndUserGroupCoordinate

string

The switch for stream collaboration between users.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
ExternalDrive

string

The switch for using external storage devices. Valid values:

  • on: Enabled.

  • off: Disabled.

off
FileMigrate

string

The file migration settings.

off
FileTransfer

string

The file transfer settings.

off
FileTransferAddress

string

The service address for the file transfer feature.

filetransfer.example.com
FileTransferInSize

integer

The file size limit for a single transfer to the cloud computer. This parameter must be used together with the transfer-in unit parameter.

100
FileTransferInUnit

string

The unit for the file size limit of a single transfer to the cloud computer.

MB
FileTransferOutSize

integer

The file size limit for a single transfer from the cloud computer. This parameter must be used together with the transfer-out unit parameter.

100
FileTransferOutUnit

string

The unit for the file size limit of a single transfer from the cloud computer.

MB
FileTransferSizeLimit

string

The switch for the file transfer size limit. Valid values:

  • on: Enabled.

  • off: Disabled.

off
FileTransferSpeed

string

The file transfer speed level.

default
FileTransferSpeedLocation

string

The effective location of the file transfer speed configured on the client.

client
FolderSync

string

The file synchronization switch. Valid values:

  • on: Enabled.

  • off: Disabled.

off
GpuAcceleration

string

Specifies whether to enable the image quality policy for cloud computers with graphics-optimized specifications. Enable this policy when high performance and user experience are required, such as in professional design scenarios.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
HoverConfigMsg

string

The switch for the floating ball configuration message prompt. Valid values:

  • on: Enabled.

  • off: Disabled.

off
HoverHibernate

string

The switch for the hibernate button on the floating ball. Valid values:

  • on: Enabled.

  • off: Disabled.

off
HoverRestart

string

The switch for the restart button on the floating ball. Valid values:

  • on: Enabled.

  • off: Disabled.

off
HoverShutdown

string

The switch for the shutdown button on the floating ball. Valid values:

  • on: Enabled.

  • off: Disabled.

off
Html5Access

string

The web client access policy.

Valid values:

  • off :

    Prohibited. Default value.

  • on :

    Allowed.

off
Html5FileTransfer

string

The web client file transfer policy.

Valid values:

  • all :

    Allows upload and download.

  • download :

    Allows download.

  • upload :

    Allows upload.

  • off :

    Disabled [default value]

off
InternetCommunicationProtocol

string

The network communication protocol.

Valid values:

  • TCP :

    Allows only TCP. Default value.

  • BOTH :

    Allows automatic switching between TCP and UDP.

BOTH
InternetPrinter

string

Specifies whether to enable the network printer feature. Valid values:

  • on: Enabled.

  • off: Disabled.

off
KeyboardControl

string

Specifies whether to enable the floating menu keyboard control. Valid values:

  • on: Enabled.

  • off: Disabled.

off
LocalDrive

string

The local drive mapping permissions.

Valid values:

  • read :

    Read-only. The cloud desktop has a mapping of the local drive, but you can only read and copy local files. You cannot modify local files.

  • readwrite :

    Read and write. The cloud desktop has a mapping of the local drive. You can read, copy, and modify local files.

  • off :

    Disabled. The cloud desktop does not have a mapping of the local drive. Default value.

readwrite
MaxReconnectTime

integer

The maximum retry time for reconnecting a cloud desktop that is disconnected due to objective reasons. Valid values: 30 to 7200. Unit: seconds.

120
McpService

string

Specifies whether to enable the MCP service. Valid values:

  • on: Enabled.

  • off: Disabled.

on
MemoryDownGradeDuration

integer

The memory downgrade duration for a single process. Valid values: 30 to 120. Unit: seconds.

30
MemoryOverload

string

Specifies whether to enable memory load protection. Valid values:

  • on: Enabled.

  • off: Disabled.

off
MemoryProcessors

array

The whitelist of processes that are not restricted by the memory usage limit.

string

The process name.

notepad.exe
MemoryProtectedMode

string

Specifies whether to enable the memory protection mode.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
MemoryRateLimit

integer

The overall memory usage percentage. Valid values: 70 to 90.

70
MemorySampleDuration

integer

The overall memory sampling duration. Valid values: 30 to 60. Unit: seconds.

30
MemorySingleRateLimit

integer

The memory usage percentage for a single process. Valid values: 30 to 60.

30
MobileRestart

string

Specifies whether to provide a restart button in the floating menu of the cloud desktop when you connect to the cloud desktop from a mobile client, including Android and iOS clients.

Note

This feature is only applicable to mobile clients of V7.4 or later.

Valid values:

  • off :

    Not provided.

  • on :

    Provided.

off
MobileSafeMenu

string

Specifies whether to enable the Windows security control for mobile clients.

off
MobileShutdown

string

Specifies whether to provide a shutdown button in the floating menu of the cloud desktop when you connect to the cloud desktop from a mobile client, including Android and iOS clients.

Note

This feature is only applicable to mobile clients of V7.4 or later.

Valid values:

  • off :

    Not provided.

  • on :

    Provided.

off
MobileWuyingKeeper

string

Specifies whether to enable Wuying Keeper for mobile clients.

off
MobileWyAssistant

string

Specifies whether to enable Wuying Assistant for mobile clients.

off
ModelLibrary

string

Specifies whether to enable the model library feature. Valid values:

  • on: Enabled.

  • off: Disabled.

off
MultiScreen

string

Specifies whether to enable the multi-screen display feature. Valid values:

  • on: Enabled.

  • off: Disabled.

off
Name

string

The policy name of the cloud desktop.

testPolicyGroupName
NetRedirect

string

The network redirection feature.

Note

This feature is in targeted invitation-only beta testing and is not available to the public.

Valid values:

  • off :

    Disabled [default value]

  • on :

    Enabled.

off
NetRedirectRule

array<object>

The list of network redirection policies.

Note

This feature is in targeted invitation-only beta testing and is not available to the public.

object

The details of the network redirection policy.

Note

This feature is in targeted invitation-only beta testing and is not available to the public.

Domain

string

The policy content.

*.example.com
Policy

string

The policy type.

Valid values:

  • allow :

    Allow.

  • block :

    Block.

allow
RuleType

string

The policy type.

Valid values:

  • prc :

    Process.

  • domain :

    Domain name.

domain
NetworkPrinter

string

Specifies whether to enable the network printer feature. Valid values:

  • on: Enabled.

  • off: Disabled.

off
OrganizationCount

string

The number of associated organizations.

2
PolicyGroupId

string

The ID of the cloud desktop policy.

pg-gx2x1dhsmthe9****
PolicyGroupType

string

The type of the cloud desktop policy.

Valid values:

  • SYSTEM :

    System policy.

  • CUSTOM :

    Custom policy.

SYSTEM
PolicyStatus

string

The status of the cloud desktop policy.

Valid values:

  • AVAILABLE :

    Available.

  • CREATING :

    Creating.

AVAILABLE
PortProxy

string

Specifies whether to enable the port proxy feature. Valid values:

  • on: Enabled.

  • off: Disabled.

off
PreemptLogin

string

The cloud desktop preemption policy.

Note

To ensure the user experience and data security of end users who are using the cloud desktop, mutual preemption among multiple users is not allowed. Therefore, this configuration defaults to off and cannot be modified.

Valid values:

  • off :

    Preemption prohibited.

off
PreemptLoginUsers

array

The usernames of the users who can preempt the cloud desktop.

string

The username of the user who can preempt the cloud desktop.

Alice
PrinterAlert

string

The printer pop-up prompt. Valid values:

  • default: Default value.

  • off: Disabled.

  • custom: Custom.

off
PrinterAlertContent

string

The content of the printer pop-up prompt.

Print Content
PrinterAlertTitle

string

The title of the printer pop-up prompt.

Print Title
PrinterRedirection

string

The printer redirection policy.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
QualityEnhancement

string

Specifies whether image quality enhancement is enabled for design and 3D common scenarios.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
RecordContent

string

Specifies whether to enable custom screen recording.

Valid values:

  • off :

    Disabled [default value]

  • on :

    Enabled.

off
RecordContentExpires

integer

The expiration time of custom screen recording files. Default value: 30 days.

30
RecordEventDuration

integer

The duration of screen recording after an event is detected in screen recording audit. Unit: minutes. Valid values: 10 to 60.

10
RecordEventFileExts

array

The screen recording event file extension.

string

The list of file name extensions for screen recording event records.

.docx
RecordEventFilePaths

array

The list of absolute paths for file monitoring in screen recording audit.

string

The absolute path for file monitoring in screen recording audit.

d:/data
RecordEventLevels

array<object>

The screen recording event level switch.

object

EventLevel

string

The event level.

HIGH
EventType

string

The event type.

StartApplication
RecordEventRegisters

array

The list of absolute paths for registry monitoring in screen recording audit.

string

The absolute path for registry monitoring in screen recording audit.

Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\USBSTOR
Recording

string

Specifies whether screen recording is enabled.

Valid values:

  • byaction_cmd_ft :

    user operation screen recording (triggered by command execution and file transfer)

  • ALLTIME :

    continuous screen recording, from connecting to the cloud desktop to disconnecting from the cloud desktop.

  • PERIOD :

    periodic screen recording, which requires setting the start and end time for screen recording.

  • byaction_commands :

    user operation screen recording (triggered only by command execution)

  • OFF :

    screen recording disabled.

  • byaction_file_transfer :

    user operation screen recording (triggered only by file transfer)

OFF
RecordingAudio

string

The option for recording cloud desktop audio.

Valid values:

  • off :

    record video only without audio [default]

  • on :

    enable audio recording.

on
RecordingDuration

integer

The playback duration of screen recording files. Unit: minutes. Recorded files are automatically split and uploaded to the storage space based on the specified duration. When a file reaches 300 MB, it is overwritten on a rolling basis.

Valid values:

  • 10 :

    10

  • 20 :

    20

  • 30 :

    30

  • 60 :

    60

10
RecordingEndTime

string

The end time of screen recording. Format: HH:MM:SS. This value is valid only when Recording is set to PERIOD.

08:59:00
RecordingExpires

integer

The retention period of screen recording files. Valid values: 1 to 180 days.

15
RecordingFps

integer

The frame rate of screen recording. Unit: FPS (frames per second).

Valid values:

  • 2 :

    2

  • 5 :

    5

  • 10 :

    10

  • 15 :

    15

5
RecordingStartTime

string

The start time of screen recording. Format: HH:MM:SS. This value is valid only when Recording is set to PERIOD.

08:00:00
RecordingUserNotify

string

The screen recording notification feature on the client.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
RecordingUserNotifyMessage

string

The screen recording notification content on the client. By default, you do not need to specify this parameter.

Your cloud desktop is being recorded
RemoteCoordinate

string

The keyboard and mouse control permissions for remote assistance.

Valid values:

  • optionalControl :

    disabled by default. You can apply for keyboard and mouse control permissions to enable it.

  • fullControl :

    full control.

  • disableControl :

    no control.

fullControl
ResetDesktop

string

The cloud desktop reset configuration.

off
ResolutionDpi

integer

The DPI value of the screen resolution.

96
ResolutionHeight

integer

The height of the resolution. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 480 to 4096.

1280
ResolutionModel

string

The resolution type.

adaptive
ResolutionWidth

integer

The width of the resolution. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 640 to 4096.

720
ResourceGroupCount

integer

The number of resource groups associated with the policy.

1
ResourceRegionId

string

The region to which the cloud desktop policy belongs.

Note

If the policy is region-independent, this value is center.

center
SafeMenu

string

The shortcut key switch for Security Center. Valid values:

  • on: Enabled.

  • off: Disabled.

off
Scope

string

The effective scope of the policy.

Valid values:

  • IP :

    IP-based.

  • GLOBAL :

    takes effect globally.

GLOBAL
ScopeValue

array

Specify this parameter when Scope is set to IP. This parameter takes effect only when Scope is set to IP.

string

The effective CIDR block.

47.100.XX.XX/24
ScreenDisplayMode

string

The screen display mode.

auto
SmoothEnhancement

string

Specifies whether to enable smoothness enhancement for daily office scenarios.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
StatusMonitor

string

Specifies whether to provide the status monitoring feature entry in the floating ball of the cloud desktop.

Valid values:

  • off :

    Not provided.

  • on :

    Provided.

on
StreamingMode

string

The applicable scenario for the streaming mode.

Valid values:

  • intelligent :

    daily office scenarios (intelligent mode)

  • smooth :

    design and 3D common scenarios (smoothness prioritized)

smooth
TargetFps

integer

The target frame rate. Valid values: 10 to 60.

30
ThreeScreen

string

The triple-screen switch. Valid values:

  • on: Enabled.

  • off: Disabled.

off
UsbRedirect

string

The USB redirection setting.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
UsbSupplyRedirectRule

array<object>

The USB redirection rule.

object

The USB redirection rule.

Description

string

The rule description.

Test rule
DeviceClass

string

The device class. This parameter is required when usbRuleType is set to 1. For more information, see Defined Class Codes.

0Eh
DeviceSubclass

string

The device subclass. This parameter is required when usbRuleType is set to 1. For more information, see Defined Class Codes.

xxh
ProductId

string

The product ID.

08**
UsbRedirectType

integer

The USB redirection type.

Valid values:

  • 1 :

    allow.

  • 2 :

    deny.

1
UsbRuleType

integer

The type of the USB redirection rule.

Valid values:

  • 1 :

    Device class.

  • 2 :

    Device vendor.

1
VendorId

string

The vendor ID. For more information, see Valid USB Vendor IDs (VIDs).

04**
UseTime

string

Specifies whether to display the usage duration on the floating ball. Valid values:

  • on: Enabled.

  • off: Disabled.

off
VideoEncAvgKbps

integer

The average video encoding bitrate. Valid values: 1000 to 50000.

1000
VideoEncMaxQP

integer

The maximum quantization parameter (QP) for video encoding, which corresponds to the lowest image quality. Valid values: 0 to 51.

20
VideoEncMinQP

integer

The minimum quantization parameter (QP) for video encoding, which corresponds to the highest image quality. Valid values: 0 to 51.

20
VideoEncPeakKbps

integer

The peak video encoding bitrate. Valid values: 1000 to 50000.

1000
VideoEncPolicy

string

The video encoding policy.

Valid values:

  • qualityFirst :

    Image quality first.

  • bandwidthFirst :

    Bitrate first.

qualityFirst
VideoRedirect

string

The multimedia redirection setting.

Valid values:

  • off :

    Disable multimedia redirection.

  • on :

    Enable multimedia redirection.

off
VisualQuality

string

The image display quality policy.

Valid values:

  • high :

    High definition.

  • low :

    Smooth.

  • medium :

    Adaptive [default value]

  • lossless :

    Lossless.

medium
Watermark

string

The watermark setting.

Valid values:

  • blind :

    Enable blind watermark.

  • off :

    Disable watermark.

  • on :

    Enable visible watermark.

on
WatermarkAntiCam

string

The anti-camera capture feature for blind watermarks.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

off
WatermarkColor

integer

The font color of the watermark. Valid values: 0 to 16777215.

0
WatermarkCustomText

string

If the WatermarkType parameter is set to custom, you must specify the custom text by using the WatermarkCustomText parameter.

custom-watermark
WatermarkDegree

number

The tilt angle of the watermark. Valid values: -10 to -30.

-10
WatermarkFontSize

integer

The font size of the watermark. Valid values: 10 to 20.

10
WatermarkFontStyle

string

The font style of the watermark.

Valid values:

  • plain :

    Plain.

  • bold :

    Bold.

plain
WatermarkPower

string

The blind watermark enhancement feature.

Valid values:

  • high :

    High.

  • low :

    Low.

  • medium :

    Medium.

medium
WatermarkRowAmount

integer

The number of watermark rows.

Note

This parameter is not yet available.

5
WatermarkSecurity

string

The security priority rule for blind watermarks.

Valid values:

  • off :

    Disabled.

  • on :

    Enabled.

on
WatermarkShadow

string

Specifies whether to enable the shadow effect for the watermark. Valid values:

  • on: Enabled.

  • off: Disabled.

off
WatermarkTransparency

string

The display depth of the watermark.

Valid values:

  • LIGHT :

    Light.

  • DARK :

    Dark.

  • MIDDLE :

    Medium.

LIGHT
WatermarkTransparencyValue

integer

The transparency of the watermark. A larger value indicates lower transparency. Valid values: 10 to 100.

10
WatermarkType

string

The watermark type.

Valid values:

  • EndUserId :

    Username.

  • Custom :

    Custom text.

  • DesktopIp :

    Cloud computer IP address.

  • ClientIp :

    Client IP address.

  • HostName :

    Last 15 characters of the cloud computer ID.

  • ClientTime :

    Current time of the cloud computer.

EndUserId
WuyingKeeper

string

Specifies whether to enable Wuying Keeper.

off
WyAssistant

string

Specifies whether to display the Wuying AI Assistant entry point in the floating ball of the cloud computer.

Valid values:

  • off :

    Not provided.

  • on :

    Provided.

on
NextToken

string

The token for the next query. An empty NextToken indicates that no more results are available.

caeba0bbb2be03f84eb48b699f0a****
PageNumber

integer

The page number of the current page in a paging query.

1
PageSize

integer

The maximum number of entries per page in a paging query. Default value: 20.

20
RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "Count": 40,
  "DescribePolicyGroups": [
    {
      "AcademicProxy": "off",
      "AdminAccess": "deny",
      "AdminKeyboardOnFullScreen": "off",
      "AdminKeyboardOnWindows": "off",
      "AppContentProtection": "off",
      "AppScreenshotBuckets": [
        {
          "BucketName": "my-bucket",
          "BucketRegionId": "cn-hangzhou"
        }
      ],
      "AuthorizeAccessPolicyRules": [
        {
          "CidrIp": "47.100.XX.XX/16",
          "Description": "Corporate office network"
        }
      ],
      "AuthorizeSecurityPolicyRules": [
        {
          "CidrIp": "47.100.XX.XX/16",
          "Description": "Allow access to the internal R&D environment",
          "IpProtocol": "tcp",
          "Policy": "accept",
          "PortRange": "22/22",
          "Priority": "1",
          "Type": "inflow"
        }
      ],
      "AutoReconnect": "off",
      "AutoSaveAppScreenshot": "off",
      "CameraRedirect": "on",
      "ClientControlMenu": "on",
      "ClientCreateSnapshot": "off",
      "ClientHibernate": "off",
      "ClientRestart": "off",
      "ClientShutdown": "off",
      "ClientTypes": [
        {
          "ClientType": "windows",
          "Status": "ON"
        }
      ],
      "Clipboard": "off",
      "ColorEnhancement": "off",
      "CpdDriveClipboard": "off",
      "CpuDownGradeDuration": 30,
      "CpuOverload": "off",
      "CpuProcessors": [
        "chrome.exe"
      ],
      "CpuProtectedMode": "on",
      "CpuRateLimit": 70,
      "CpuSampleDuration": 10,
      "CpuSingleRateLimit": 70,
      "Description": "newDescription",
      "DesktopCount": 1,
      "DesktopGroupCount": 1,
      "DeviceConnectHint": "off",
      "DeviceRedirects": [
        {
          "DeviceType": "camera",
          "RedirectType": "usbRedirect"
        }
      ],
      "DeviceRules": [
        {
          "DeviceName": "sandisk",
          "DevicePid": "0x55b1",
          "DeviceType": "storage",
          "DeviceVid": "0x0781",
          "OptCommand": "2:0",
          "Platforms": "Windows",
          "RedirectType": "usbRedirect"
        }
      ],
      "DiskOverload": "off",
      "DisplayMode": "adminCustom",
      "DomainList": "off",
      "DomainResolveRule": [
        {
          "Description": "Test rule",
          "Domain": "*.example.com",
          "Policy": "allow"
        }
      ],
      "DomainResolveRuleType": "on",
      "EdsCount": 2,
      "EndUserApplyAdminCoordinate": "on",
      "EndUserCount": "3",
      "EndUserGroupCoordinate": "on",
      "ExternalDrive": "off",
      "FileMigrate": "off",
      "FileTransfer": "off",
      "FileTransferAddress": "filetransfer.example.com",
      "FileTransferInSize": 100,
      "FileTransferInUnit": "MB",
      "FileTransferOutSize": 100,
      "FileTransferOutUnit": "MB",
      "FileTransferSizeLimit": "off",
      "FileTransferSpeed": "default",
      "FileTransferSpeedLocation": "client",
      "FolderSync": "off",
      "GpuAcceleration": "off",
      "HoverConfigMsg": "off",
      "HoverHibernate": "off",
      "HoverRestart": "off",
      "HoverShutdown": "off",
      "Html5Access": "off",
      "Html5FileTransfer": "off",
      "InternetCommunicationProtocol": "BOTH",
      "InternetPrinter": "off",
      "KeyboardControl": "off",
      "LocalDrive": "readwrite",
      "MaxReconnectTime": 120,
      "McpService": "on",
      "MemoryDownGradeDuration": 30,
      "MemoryOverload": "off",
      "MemoryProcessors": [
        "notepad.exe"
      ],
      "MemoryProtectedMode": "on",
      "MemoryRateLimit": 70,
      "MemorySampleDuration": 30,
      "MemorySingleRateLimit": 30,
      "MobileRestart": "off",
      "MobileSafeMenu": "off",
      "MobileShutdown": "off",
      "MobileWuyingKeeper": "off",
      "MobileWyAssistant": "off",
      "ModelLibrary": "off",
      "MultiScreen": "off",
      "Name": "testPolicyGroupName",
      "NetRedirect": "off",
      "NetRedirectRule": [
        {
          "Domain": "*.example.com",
          "Policy": "allow",
          "RuleType": "domain"
        }
      ],
      "NetworkPrinter": "off",
      "OrganizationCount": "2",
      "PolicyGroupId": "pg-gx2x1dhsmthe9****",
      "PolicyGroupType": "SYSTEM",
      "PolicyStatus": "AVAILABLE",
      "PortProxy": "off",
      "PreemptLogin": "off",
      "PreemptLoginUsers": [
        "Alice"
      ],
      "PrinterAlert": "off",
      "PrinterAlertContent": "Print Content",
      "PrinterAlertTitle": "Print Title",
      "PrinterRedirection": "on",
      "QualityEnhancement": "off",
      "RecordContent": "off",
      "RecordContentExpires": 30,
      "RecordEventDuration": 10,
      "RecordEventFileExts": [
        ".docx"
      ],
      "RecordEventFilePaths": [
        "d:/data"
      ],
      "RecordEventLevels": [
        {
          "EventLevel": "HIGH",
          "EventType": "StartApplication"
        }
      ],
      "RecordEventRegisters": [
        "Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR"
      ],
      "Recording": "OFF",
      "RecordingAudio": "on",
      "RecordingDuration": 10,
      "RecordingEndTime": "08:59:00",
      "RecordingExpires": 15,
      "RecordingFps": 5,
      "RecordingStartTime": "08:00:00",
      "RecordingUserNotify": "off",
      "RecordingUserNotifyMessage": "Your cloud computer is being recorded",
      "RemoteCoordinate": "fullControl",
      "ResetDesktop": "off",
      "ResolutionDpi": 96,
      "ResolutionHeight": 1280,
      "ResolutionModel": "adaptive",
      "ResolutionWidth": 720,
      "ResourceGroupCount": 1,
      "ResourceRegionId": "center",
      "SafeMenu": "off",
      "Scope": "GLOBAL",
      "ScopeValue": [
        "47.100.XX.XX/24"
      ],
      "ScreenDisplayMode": "auto",
      "SmoothEnhancement": "off",
      "StatusMonitor": "on",
      "StreamingMode": "smooth",
      "TargetFps": 30,
      "ThreeScreen": "off",
      "UsbRedirect": "on",
      "UsbSupplyRedirectRule": [
        {
          "Description": "Test rule",
          "DeviceClass": "0Eh",
          "DeviceSubclass": "xxh",
          "ProductId": "08**",
          "UsbRedirectType": 1,
          "UsbRuleType": 1,
          "VendorId": "04**"
        }
      ],
      "UseTime": "off",
      "VideoEncAvgKbps": 1000,
      "VideoEncMaxQP": 20,
      "VideoEncMinQP": 20,
      "VideoEncPeakKbps": 1000,
      "VideoEncPolicy": "qualityFirst",
      "VideoRedirect": "off",
      "VisualQuality": "medium",
      "Watermark": "on",
      "WatermarkAntiCam": "off",
      "WatermarkColor": 0,
      "WatermarkCustomText": "custom-watermark",
      "WatermarkDegree": -10,
      "WatermarkFontSize": 10,
      "WatermarkFontStyle": "plain",
      "WatermarkPower": "medium",
      "WatermarkRowAmount": 5,
      "WatermarkSecurity": "on",
      "WatermarkShadow": "off",
      "WatermarkTransparency": "LIGHT",
      "WatermarkTransparencyValue": 10,
      "WatermarkType": "EndUserId",
      "WuyingKeeper": "off",
      "WyAssistant": "on"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.