All Products
Search

This Product

    Elastic Desktop Service:DescribePolicyGroups

    Document Center

    Elastic Desktop Service:DescribePolicyGroups

    Last Updated:Jun 25, 2026

    Retrieves the details of a cloud computer policy.

    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. Call DescribeRegions to query the regions supported by WUYING Workspace.

    cn-hangzhou
    MaxResults

    integer

    No

    The number of entries per page.

    • Maximum value: 100

    • Default value: 10

    10
    NextToken

    string

    No

    The pagination token. Set this parameter to the NextToken value returned in the previous response. Do not set this parameter for the first request.

    caeba0bbb2be03f84eb48b699f0a4883
    PolicyGroupId

    array

    No

    The list of cloud computer policy IDs.

    system-all-enabled-policy

    string

    No

    The cloud computer policy ID.

    system-all-enabled-policy
    Scope

    string

    No

    The effective scope of the cloud computer policy.

    Valid values:

    • ALL :

      All policies

    • IP :

      Effective based on IP address

    • GLOBAL :

      Globally effective [default]

    GLOBAL
    ExternalPolicyGroupIds

    array

    No

    The list of cloud computer policy IDs to exclude from the query results.

    string

    No

    The cloud computer policy ID to exclude from the query results.

    pg-0cid8v30p16k4****
    PageNumber

    integer

    No

    PageSize

    integer

    No

    BusinessChannel

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    A collection of the returned information.

    NextToken

    string

    The pagination token for the next query. If NextToken is empty, no further pages exist.

    caeba0bbb2be03f84eb48b699f0a****
    RequestId

    string

    The request ID.

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

    integer

    PageNumber

    integer

    PageSize

    integer

    DescribePolicyGroups

    array<object>

    The detailed information about the cloud computer policies.

    array<object>

    The detailed information about the cloud computer policies.

    PolicyStatus

    string

    The status of the cloud computer policy.

    Valid values:

    • AVAILABLE :

      Active

    • CREATING :

      Creating

    AVAILABLE
    Html5Access

    string

    The web client access policy.

    Valid values:

    • off :

      Disabled [default]

    • on :

      Enabled

    off
    WatermarkType

    string

    The watermark type.

    Valid values:

    • EndUserId :

      Username

    • Custom :

      Custom text

    • DesktopIp :

      Cloud computer IP address

    • ClientIp :

      Client IP address

    • HostName :

      Last 15 digits of the cloud computer ID

    • ClientTime :

      Current time on the cloud computer

    EndUserId
    PreemptLogin

    string

    The cloud computer preemption policy.

    Note

    To ensure user experience and data security for end users currently using a cloud computer, mutual preemption between multiple users is not allowed. This parameter defaults to off and cannot be modified.

    Valid values:

    • off :

      Preemption disabled

    off
    WatermarkCustomText

    string

    If you set WatermarkType to custom, you must also specify WatermarkCustomText.

    custom-watermark
    Clipboard

    string

    The clipboard permissions.

    Valid values:

    • read :

      One-way allowed. You can copy local content to the cloud computer but cannot copy cloud computer content to the local device.

    • readwrite :

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

    • write :

      One-way allowed. You can copy cloud computer content to the local device but cannot copy local content to the cloud computer.

    • off :

      Two-way disabled. No copying is allowed between the cloud computer and the local device. [default]

    off
    PolicyGroupId

    string

    The cloud computer policy ID.

    pg-gx2x1dhsmthe9****
    PrinterRedirection

    string

    The printer redirection policy.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    on
    WatermarkTransparency

    string

    The watermark transparency level.

    Valid values:

    • LIGHT :

      Light

    • DARK :

      Dark

    • MIDDLE :

      Medium

    LIGHT
    Html5FileTransfer

    string

    The file transfer policy for the web client.

    Valid values:

    • all :

      Upload and download allowed

    • download :

      Download allowed

    • upload :

      Upload allowed

    • off :

      Disabled [default]

    off
    UsbRedirect

    string

    USB redirection.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    on
    PolicyGroupType

    string

    The cloud computer policy type.

    Valid values:

    • SYSTEM :

      System policy

    • CUSTOM :

      Custom policy

    SYSTEM
    Watermark

    string

    Watermark.

    Valid values:

    • blind :

      Blind watermark enabled

    • off :

      Watermark disabled

    • on :

      Visible watermark enabled

    on
    VisualQuality

    string

    The image display quality policy.

    Valid values:

    • high :

      High definition

    • low :

      Smooth

    • medium :

      Automatic rotation [default]

    • lossless :

      Lossless

    medium
    EdsCount

    integer

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

    2
    Name

    string

    The cloud computer policy name.

    testPolicyGroupName
    LocalDrive

    string

    The local disk mapping permissions.

    Valid values:

    • read :

      Read-only. Local disk mapping is available on the cloud computer, but you can only read (copy) local files and cannot modify them.

    • readwrite :

      Read and write. Local disk mapping is available on the cloud computer, and you can read (copy) and modify local files.

    • off :

      Disabled. No local disk mapping is available on the cloud computer. [default]

    readwrite
    AuthorizeSecurityPolicyRules

    array<object>

    The security group control rules.

    object

    The security group control rule.

    Type

    string

    The rule direction of the security group control rule.

    Valid values:

    • outflow :

      Outbound

    • inflow :

      Inbound

    inflow
    Policy

    string

    The authorization policy of the security group control rule.

    Valid values:

    • drop :

      Deny policy. Denies all access requests.

    • accept :

      Allow policy. Accepts all access requests.

    accept
    Description

    string

    The description of the security group control rule.

    test
    PortRange

    string

    The port range of the security group control rule.

    22/22
    IpProtocol

    string

    The protocol type of the security group control rule.

    Valid values:

    • tcp :

      TCP protocol

    • udp :

      UDP protocol

    • all :

      All protocols

    • gre :

      GRE protocol

    • icmp :

      ICMP (IPv4) protocol

    tcp
    Priority

    string

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

    1
    CidrIp

    string

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

    47.100.XX.XX/16
    AuthorizeAccessPolicyRules

    array<object>

    The client IP address whitelist. Only IP addresses within the whitelisted CIDR blocks can access the cloud computer.

    object

    The client IP address whitelist entry.

    Description

    string

    The remarks for the client-accessible CIDR block.

    test
    CidrIp

    string

    The client-accessible IP address segment. The value is an IPv4 CIDR block.

    47.100.XX.XX/16
    ClientTypes

    array<object>

    The logon method control list. Controls which clients can access the cloud computer.

    object

    The logon method control rule.

    Status

    string

    Whether a specific client type is allowed to connect to the cloud computer.

    Valid values:

    • OFF :

      Not allowed

    • ON :

      Allowed

    ON
    ClientType

    string

    The client type.

    Valid values:

    • html5 :

      Web client

    • android :

      Android client

    • windows :

      Windows client

    • ios :

      iOS client

    • macos :

      macOS client

    windows
    PreemptLoginUsers

    array

    The usernames of users who can preempt the cloud computer.

    string

    The username of a user who can preempt the cloud computer.

    Alice
    GpuAcceleration

    string

    Whether to enable the image quality policy for graphics-specification cloud computers. Enable this policy if you have high requirements for cloud computer performance and user experience, such as in professional design scenarios.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    off
    UsbSupplyRedirectRule

    array<object>

    The USB redirection rule.

    object

    The USB redirection rule.

    VendorId

    string

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

    04**
    ProductId

    string

    The product ID.

    08**
    Description

    string

    The rule description.

    Test rule
    UsbRedirectType

    integer

    The USB redirection type.

    Valid values:

    • 1 :

      Allow

    • 2 :

      Deny

    1
    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
    UsbRuleType

    integer

    The USB redirection rule type.

    Valid values:

    • 1 :

      Device class

    • 2 :

      Device vendor

    1
    DomainResolveRuleType

    string

    The domain name resolution policy switch.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    on
    DomainResolveRule

    array<object>

    The domain name resolution policy list.

    object

    The domain name resolution policy details.

    Domain

    string

    The domain name.

    *.example.com
    Policy

    string

    The resolution policy.

    Valid values:

    • allow :

      Allow

    • block :

      Deny

    allow
    Description

    string

    The policy description.

    Test rule
    NetRedirectRule

    array<object>

    The network redirection policy list.

    Note

    This feature is in invitational preview and is not publicly available.

    object

    The network redirection policy details.

    Note

    This feature is in invitational preview and is not publicly available.

    Domain

    string

    The policy content.

    *.example.com
    RuleType

    string

    The policy type.

    Valid values:

    • prc :

      Process

    • domain :

      Domain name

    domain
    Policy

    string

    The policy type.

    Valid values:

    • allow :

      Allow

    • block :

      Deny

    allow
    Recording

    string

    Whether to enable screen recording.

    Valid values:

    • byaction_cmd_ft :

      User operation-triggered screen recording (triggered when executing commands and transferring files)

    • ALLTIME :

      Full-session screen recording (from connection to disconnection)

    • PERIOD :

      Interval-based screen recording (requires setting start and end times)

    • byaction_commands :

      User operation-triggered screen recording (triggered only when executing commands)

    • OFF :

      Screen recording disabled

    • byaction_file_transfer :

      User operation-triggered screen recording (triggered only when transferring files)

    OFF
    RecordingStartTime

    string

    The screen recording start time in HH:MM:SS format. This parameter takes effect only when Recording is set to PERIOD.

    08:00:00
    RecordingEndTime

    string

    The screen recording end time in HH:MM:SS format. This parameter takes effect only when Recording is set to PERIOD.

    08:59:00
    RecordingFps

    integer

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

    Valid values:

    • 2 :

      2

    • 5 :

      5

    • 10 :

      10

    • 15 :

      15

    5
    RecordingExpires

    integer

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

    15
    CameraRedirect

    string

    Whether to enable local camera redirection.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled [default]

    on
    NetRedirect

    string

    Network redirection.

    Note

    This feature is in invitational preview and is not publicly available.

    Valid values:

    • off :

      Disabled [default]

    • on :

      Enabled

    off
    AppContentProtection

    string

    Whether to enable the anti-screenshot feature.

    Valid values:

    • off :

      Disabled [default]

    • on :

      Enabled

    off
    RecordContent

    string

    Whether to enable custom screen recording.

    Valid values:

    • off :

      Disabled [default]

    • on :

      Enabled

    off
    RecordContentExpires

    integer

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

    30
    RemoteCoordinate

    string

    The keyboard and mouse control permissions during remote assistance.

    Valid values:

    • optionalControl :

      Disabled by default. Click to request keyboard and mouse control permissions.

    • fullControl :

      Full control

    • disableControl :

      No control

    fullControl
    RecordingDuration

    integer

    The screen recording file viewing duration in minutes. Recording files are automatically split based on this duration and uploaded to the bucket. When a file reaches 300 MB, it is preferentially rolled over.

    Valid values:

    • 10 :

      10

    • 20 :

      20

    • 30 :

      30

    • 60 :

      60

    10
    Scope

    string

    The effective scope of the policy.

    Valid values:

    • IP :

      Effective based on IP address

    • GLOBAL :

      Globally effective

    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
    RecordingAudio

    string

    The option to record audio from the cloud computer.

    Valid values:

    • off :

      Record video only, not audio [default]

    • on :

      Enable audio recording

    on
    InternetCommunicationProtocol

    string

    The network communication protocol.

    Valid values:

    • TCP :

      TCP only [default]

    • BOTH :

      Automatically switch between TCP and UDP

    BOTH
    VideoRedirect

    string

    Multimedia redirection.

    Valid values:

    • off :

      Media redirection disabled

    • on :

      Media redirection enabled

    off
    WatermarkTransparencyValue

    integer

    The watermark transparency. A higher value means lower transparency. Valid values: 10 to 100.

    10
    WatermarkColor

    integer

    The watermark font color in RGB format. Valid values: 0 to 16777215.

    0
    WatermarkFontSize

    integer

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

    10
    WatermarkFontStyle

    string

    The watermark font style.

    Valid values:

    • plain :

      Plain

    • bold :

      Bold

    plain
    WatermarkDegree

    number

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

    -10
    WatermarkRowAmount

    integer

    The number of watermark rows.

    Note

    This parameter is not publicly available.

    5
    EndUserApplyAdminCoordinate

    string

    The switch for users to request administrator assistance.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    on
    EndUserGroupCoordinate

    string

    The switch for stream collaboration between users.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    on
    CpuProtectedMode

    string

    The CPU protection mode switch.

    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 in seconds. Valid values: 10 to 60.

    10
    CpuSingleRateLimit

    integer

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

    70
    CpuDownGradeDuration

    integer

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

    30
    CpuProcessors

    array

    The process whitelist exempt from CPU usage limits.

    string

    The process name.

    chrome.exe
    MemoryProtectedMode

    string

    The memory protection mode switch.

    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 in seconds. Valid values: 30 to 60.

    30
    MemorySingleRateLimit

    integer

    The memory usage percentage per worker. Valid values: 30 to 60.

    30
    MemoryDownGradeDuration

    integer

    The memory downclocking duration per process in seconds. Valid values: 30 to 120.

    30
    MemoryProcessors

    array

    The process whitelist exempt from memory usage limits.

    string

    The process name.

    notepad.exe
    WatermarkSecurity

    string

    The blind watermark security priority rule.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    on
    WatermarkAntiCam

    string

    The blind watermark anti-photo feature.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    off
    WatermarkPower

    string

    The blind watermark enhancement feature.

    Valid values:

    • high :

      High

    • low :

      Low

    • medium :

      Medium

    medium
    RecordingUserNotify

    string

    The screen recording client notification feature.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    off
    RecordingUserNotifyMessage

    string

    The screen recording client notification message. Leave empty by default.

    Your cloud computer is being recorded
    AdminAccess

    string

    Whether end users have administrative permission after connecting to the cloud computer.

    Note

    This feature is in invitational preview and is not publicly available.

    deny
    MaxReconnectTime

    integer

    The maximum retry time for reconnecting to the cloud computer after a disconnection caused by objective reasons. Valid values: 30 to 7200 seconds.

    120
    DisplayMode

    string

    The display mode.

    Valid values:

    • clientCustom :

      User self-configuration

    • adminOffice :

      Daily office scenario

    • adminDesign :

      3D application scenario

    • adminCustom :

      Administrator-defined parameters

    adminCustom
    StreamingMode

    string

    The streaming mode adaptation scenario.

    Valid values:

    • intelligent :

      Daily office scenario (intelligent mode)

    • smooth :

      Design and 3D application scenario (smooth priority)

    smooth
    ColorEnhancement

    string

    Whether to enable color enhancement for design and 3D application scenarios.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    off
    SmoothEnhancement

    string

    Whether to enable smoothness enhancement for daily office scenarios.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    off
    QualityEnhancement

    string

    Whether to enable image quality enhancement for design and 3D application scenarios.

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    off
    VideoEncPolicy

    string

    The video encoding policy.

    Valid values:

    • qualityFirst :

      Image quality priority

    • bandwidthFirst :

      Bitrate policy priority

    qualityFirst
    TargetFps

    integer

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

    30
    VideoEncMinQP

    integer

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

    20
    VideoEncMaxQP

    integer

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

    20
    VideoEncAvgKbps

    integer

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

    1000
    VideoEncPeakKbps

    integer

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

    1000
    DeviceRedirects

    array<object>

    The device redirection rule list.

    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.

    • usbRedirect: USB redirection.

    • deviceRedirect: Device redirection.

    • off: Disabled.

    usbRedirect
    DeviceRules

    array<object>

    The custom peripheral rule list.

    object

    The custom peripheral rule.

    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 controller (NIC)

    storage
    DeviceName

    string

    The device name.

    sandisk
    DeviceVid

    string

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

    0x0781
    DevicePid

    string

    The product ID.

    0x55b1
    RedirectType

    string

    The redirection type.

    Valid values:

    • deviceRedirect :

      Device redirection

    • usbRedirect :

      USB redirection

    • off :

      Redirection disabled

    usbRedirect
    OptCommand

    string

    The link optimization command.

    2:0
    Platforms

    string

    WyAssistant

    string

    Whether to provide the WUYING AI Assistant feature in the floating ball when accessing the cloud computer.

    Valid values:

    • off :

      Not provided

    • on :

      Provided

    on
    ResourceRegionId

    string

    The region to which the cloud computer policy belongs.

    Note

    For region-less policies, this value is center.

    center
    DomainList

    string

    The access control for domain names. Wildcards (*) are supported. Separate multiple domain names with commas (,).

    Valid values:

    • off :

      Disabled

    • on :

      Enabled

    off
    StatusMonitor

    string

    Whether to provide the status monitoring feature in the floating ball when accessing the cloud computer.

    Valid values:

    • off :

      Not provided

    • on :

      Provided

    on
    MobileRestart

    string

    Whether to display the restart button in the floating ball when accessing the cloud computer from mobile clients (including Android and iOS clients).

    Note

    Applies only to mobile clients of V7.4 or later.

    Valid values:

    • off :

      Not provided

    • on :

      Provided

    off
    MobileShutdown

    string

    Whether to display the shutdown button in the floating ball when accessing the cloud computer from mobile clients (including Android and iOS clients).

    Note

    Applies only to mobile clients of V7.4 or later.

    Valid values:

    • off :

      Not provided

    • on :

      Provided

    off
    DesktopCount

    integer

    The number of cloud computers associated with this policy.

    1
    DesktopGroupCount

    integer

    The number of computer pools associated with this policy.

    1
    ResourceGroupCount

    integer

    The number of resource groups associated with this policy.

    1
    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
    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
    RecordEventDuration

    integer

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

    10
    ResetDesktop

    string

    Resets the cloud computer.

    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

    The automatic client reconnection configuration.

    off
    MobileWuyingKeeper

    string

    The WUYING Keeper switch for mobile clients.

    off
    MobileSafeMenu

    string

    The Windows security control switch for mobile clients.

    off
    MobileWyAssistant

    string

    The Xiaoying AI Assistant switch for mobile clients.

    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

    KeyboardControl

    string

    AdminKeyboardOnWindows

    string

    AdminKeyboardOnFullScreen

    string

    RecordEventLevels

    array<object>

    The screen recording event severity switch.

    object

    EventType

    string

    The event type.

    EventLevel

    string

    The event severity.

    RecordEventFileExts

    array

    The screen recording event suffix.

    string

    Description

    string

    NetworkPrinter

    string

    EndUserCount

    string

    OrganizationCount

    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": "Test rule",
          "UsbRedirectType": 1,
          "DeviceClass": "0Eh",
          "DeviceSubclass": "xxh",
          "UsbRuleType": 1
        }
      ],
      "DomainResolveRuleType": "on",
      "DomainResolveRule": [
        {
          "Domain": "*.example.com",
          "Policy": "allow",
          "Description": "Test rule"
        }
      ],
      "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": "Your cloud computer is being recorded",
      "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": [
        "Computer\\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": "",
      "KeyboardControl": "",
      "AdminKeyboardOnWindows": "",
      "AdminKeyboardOnFullScreen": "",
      "RecordEventLevels": [
        {
          "EventType": "",
          "EventLevel": ""
        }
      ],
      "RecordEventFileExts": [
        ""
      ],
      "Description": "",
      "NetworkPrinter": "",
      "EndUserCount": "",
      "OrganizationCount": ""
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.