All Products
Search

This Product

    Elastic Desktop Service:DescribeCenterPolicyList

    Document Center

    Elastic Desktop Service:DescribeCenterPolicyList

    Last Updated:Jun 17, 2026

    Queries the details of region-free 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PageNumber

    integer

    No

    The page number of the current page in a paged query. Paging starts from page 1.
    Default value: 1.

    1
    PageSize

    integer

    No

    The maximum number of entries per page in a paged query. Paging is used to return results in batches.

    20
    PolicyGroupId

    array

    No

    The list of cloud desktop policy IDs.

    string

    No

    The cloud desktop policy ID.

    pg-53iyi2aar0nd6****
    Scope

    string

    No

    The effective scope of the cloud desktop policy.

    Valid values:

    • IP :

      effective for specified IP addresses.

    • GLOBAL :

      effective globally.

    GLOBAL
    BusinessType

    integer

    Yes

    The business type.

    Valid values:

    • 1 :

      public cloud.

    • 8 :

      commercial edition.

    1
    ResourceType

    string

    Yes

    The resource type.

    Valid values:

    • app :

      cloud application.

    • desktop :

      cloud desktop.

    desktop
    PortProxy

    string

    No

    ModelLibrary

    string

    No

    AcademicProxy

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of query results.

    20
    RequestId

    string

    The request ID.

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    DescribePolicyGroups

    array<object>

    The details of the cloud desktop policies.

    array<object>

    The details of the cloud desktop policies.

    PolicyStatus

    string

    The cloud desktop policy status.

    AVAILABLE
    Html5Access

    string

    The web client access policy.

    off
    WatermarkType

    string

    The watermark type.

    EndUserId
    WatermarkCustomText

    string

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

    custom-watermark
    Clipboard

    string

    The clipboard permission.

    off
    PolicyGroupId

    string

    The policy ID.

    pg-gx2x1dhsmthe9****
    PrinterRedirection

    string

    The printer redirection policy.

    off
    Html5FileTransfer

    string

    The web client file transfer policy.

    off
    UsbRedirect

    string

    The USB redirection setting.

    off
    PolicyGroupType

    string

    The policy type.

    SYSTEM
    Watermark

    string

    The watermark setting.

    on
    VisualQuality

    string

    The image display quality policy.

    medium
    Name

    string

    The policy name.

    testPolicyGroupName
    LocalDrive

    string

    The local drive mapping permission.

    readwrite
    AuthorizeSecurityPolicyRules

    array<object>

    The list of security group control rules.

    object

    The list of security group control rules.

    Type

    string

    The direction of the security group control rule.

    inflow
    Policy

    string

    The authorization policy of the security group control rule.

    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.

    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, specified as an IPv4 CIDR block.

    47.100.XX.XX/16
    AuthorizeAccessPolicyRules

    array<object>

    The client access IP whitelist.

    object

    The client access IP whitelist.

    Description

    string

    The description of the client access IP address range.

    test
    CidrIp

    string

    The client access IP address range, specified as an IPv4 CIDR block.

    47.100.XX.XX/16
    ClientTypes

    array<object>

    The logon method control rules.

    object

    The logon method control rules.

    Status

    string

    Indicates whether clients of a specific type can log on to Cloud Desktop.

    on
    ClientType

    string

    The client type.

    windows
    GpuAcceleration

    string

    Indicates whether the image quality policy is enabled for GPU-accelerated cloud desktops. Enable this policy when high performance and user experience are required, such as in professional design scenarios.

    off
    UsbSupplyRedirectRule

    array<object>

    The USB redirection rules.

    object

    The USB redirection rules.

    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.

    测试规则
    UsbRedirectType

    integer

    The USB redirection type.

    1
    UsbRuleType

    integer

    The USB redirection rule type.

    1
    DomainResolveRuleType

    string

    The domain name resolution policy switch.

    on
    DomainResolveRule

    array<object>

    The domain name resolution policy details.

    object

    The domain name resolution policy details.

    Domain

    string

    The domain name.

    *.example.com
    Policy

    string

    The resolution policy.

    allow
    Description

    string

    The policy description.

    测试规则
    NetRedirectRule

    array<object>

    The network redirection policy details.

    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 domain name.

    *.example.com
    RuleType

    string

    The rule type.

    domain
    Policy

    string

    The redirection policy.

    allow
    Recording

    string

    Indicates whether screen recording is enabled.

    off
    RecordingStartTime

    string

    The screen recording start time, in the format of HH:MM:SS. This value is meaningful only when Recording is set to period.

    08:00:00
    RecordingEndTime

    string

    The screen recording end time, in the format of HH:MM:SS. This value is meaningful only when Recording is set to period.

    08:59:00
    RecordingFps

    integer

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

    5
    RecordingExpires

    integer

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

    15
    CameraRedirect

    string

    Indicates whether local camera redirection is enabled.

    on
    NetRedirect

    string

    The network redirection setting.

    Note

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

    off
    AppContentProtection

    string

    Indicates whether the screenshot prevention feature is enabled.

    off
    RecordContent

    string

    Indicates whether custom screen recording is enabled.

    off
    RecordContentExpires

    integer

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

    30
    RemoteCoordinate

    string

    The keyboard and mouse control permission for remote assistance.

    fullControl
    RecordingDuration

    integer

    The duration of each screen recording file. Unit: minutes. Recording files are automatically split and uploaded to the storage space based on the specified duration. Files are rolled over when they reach 300 MB.

    10
    Scope

    string

    The effective scope of the policy.

    GLOBAL
    ScopeValue

    array

    The effective CIDR block.

    string

    The effective CIDR block.

    47.100.XX.XX/24
    RecordingAudio

    string

    The option for recording cloud desktop audio.

    on
    InternetCommunicationProtocol

    string

    The network communication protocol.

    tcp
    VideoRedirect

    string

    The multimedia redirection setting.

    off
    WatermarkTransparencyValue

    integer

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

    10
    WatermarkColor

    integer

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

    0
    WatermarkFontSize

    integer

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

    10
    WatermarkFontStyle

    string

    The watermark font style.

    plain
    WatermarkDegree

    number

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

    -10
    WatermarkRowAmount

    integer

    The number of watermark rows.

    3
    EndUserApplyAdminCoordinate

    string

    Indicates whether users can request administrator assistance.

    off
    EndUserGroupCoordinate

    string

    Indicates whether users within the same office network can share cloud desktops.

    off
    CpuProtectedMode

    string

    The CPU protection mode switch.

    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
    CpuDownGradeDuration

    integer

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

    30
    CpuProcessors

    array

    The process name.

    string

    The process name.

    chrome.exe
    MemoryProtectedMode

    string

    The memory protection mode switch.

    off
    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 of a single process. Valid values: 30 to 60.

    30
    MemoryDownGradeDuration

    integer

    The memory throttling duration of a single process. Valid values: 30 to 120. Unit: seconds.

    30
    MemoryProcessors

    array

    The process name.

    string

    The process name.

    notepad.exe
    WatermarkSecurity

    string

    The invisible watermark security priority rule.

    on
    WatermarkAntiCam

    string

    The invisible watermark anti-photography feature.

    off
    WatermarkPower

    string

    The invisible watermark enhancement feature.

    medium
    RecordingUserNotify

    string

    Indicates whether end users are notified that screen recording is enabled.

    off
    RecordingUserNotifyMessage

    string

    The notification message displayed to end users about screen recording.

    录屏已开启
    AdminAccess

    string

    Indicates whether the user has administrator permissions after connecting to the cloud desktop.

    Note

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

    deny
    MaxReconnectTime

    integer

    The maximum reconnection retry time when the cloud desktop is disconnected due to external reasons. Valid values: 30 to 7200. Unit: seconds.

    120
    DisplayMode

    string

    The display mode.

    adminCustom
    StreamingMode

    string

    The streaming mode adaptation scenario.

    smooth
    ColorEnhancement

    string

    Indicates whether color enhancement is enabled. Common scenarios: design and 3D applications.

    off
    SmoothEnhancement

    string

    Indicates whether smoothness enhancement is enabled for daily office scenarios.

    off
    QualityEnhancement

    string

    Indicates whether image quality enhancement is enabled. Common scenarios: design and 3D applications.

    off
    VideoEncPolicy

    string

    The video encoding policy.

    qualityFirst
    TargetFps

    integer

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

    30
    VideoEncMinQP

    integer

    The minimum QP for video encoding, which represents the highest quality. Valid values: 0 to 51.

    20
    VideoEncMaxQP

    integer

    The maximum QP for video encoding, which represents the lowest image quality. Valid values: 0 to 51.

    20
    VideoEncAvgKbps

    integer

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

    1000
    VideoEncPeakKbps

    integer

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

    2000
    DeviceRedirects

    array<object>

    The device redirection rules.

    object

    The device redirection rules.

    DeviceType

    string

    The peripheral type.

    camera
    RedirectType

    string

    The redirection type.

    usbRedirect
    DeviceRules

    array<object>

    The custom peripheral device rules.

    object

    The custom peripheral device rules.

    DeviceType

    string

    The peripheral type.

    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.

    usbRedirect
    OptCommand

    string

    The link optimization instruction.

    2:0
    Platforms

    string

    WyAssistant

    string

    Indicates whether the WUYING AI Assistant entry is provided in the cloud desktop floating ball.

    on
    StatusMonitor

    string

    Indicates whether the status monitoring entry is provided in the cloud desktop floating ball.

    on
    MobileRestart

    string

    Indicates whether the restart button is provided in the cloud desktop floating ball when connecting through a mobile client (Android client).

    Note

    Applicable only to mobile clients V7.4 or later.

    off
    MobileShutdown

    string

    Indicates whether the shutdown button is provided in the cloud desktop floating ball when connecting through a mobile client (Android client).

    Note

    Applicable only to mobile clients V7.4 or later.

    off
    DesktopCount

    integer

    The number of cloud desktops associated with this policy.

    1
    DesktopGroupCount

    integer

    The number of cloud desktop pools associated with this policy.

    1
    ResourceGroupCount

    integer

    The number of resource groups associated with this policy.

    1
    ResolutionModel

    string

    The resolution type.

    adaptive
    ResolutionWidth

    integer

    The resolution width. Unit: pixels.

    1920
    ResolutionHeight

    integer

    The resolution height. Unit: pixels.

    1280
    Taskbar

    string

    The application taskbar.

    Note

    Applicable only to cloud application policies.

    off
    NoOperationDisconnect

    string

    The no-operation disconnect setting.

    Note

    Applicable only to cloud application policies.

    off
    NoOperationDisconnectTime

    integer

    The no-operation disconnect duration. Unit: seconds.

    Note

    Applicable only to cloud application policies.

    120
    DisconnectKeepSession

    string

    The session retention on disconnect setting.

    Note

    Applicable only to cloud application policies.

    persistent
    DisconnectKeepSessionTime

    integer

    The session retention duration on disconnect. Unit: seconds.

    Note

    Applicable only to cloud application policies.

    120
    DomainRegisterValue

    string

    The effective field for domain name resolution.

    xxxx
    RecordEventFilePaths

    array

    The absolute paths for file monitoring in screen recording audit.

    string

    The absolute paths for file monitoring in screen recording audit.

    d:/data
    RecordEventRegisters

    array

    The absolute paths for registry monitoring in screen recording audit.

    string

    The absolute paths for registry monitoring in screen recording audit.

    计算机\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
    InternetPrinter

    string

    SafeMenu

    string

    ScreenDisplayMode

    string

    ClientControlMenu

    string

    FileTransferSpeedLocation

    string

    FileTransferAddress

    string

    FileTransferSpeed

    string

    CpdDriveClipboard

    string

    UseTime

    string

    ResolutionDpi

    integer

    HoverConfigMsg

    string

    ClientHibernate

    string

    ClientRestart

    string

    ClientShutdown

    string

    HoverHibernate

    string

    HoverRestart

    string

    HoverShutdown

    string

    MultiScreen

    string

    AcademicProxy

    string

    ModelLibrary

    string

    PortProxy

    string

    WatermarkShadow

    string

    MobileWyAssistant

    string

    MobileSafeMenu

    string

    MobileWuyingKeeper

    string

    ExternalDrive

    string

    KmsServerConfig

    string

    KmsServer

    string

    ClientCreateSnapshot

    string

    DiskOverload

    string

    CpuOverload

    string

    MemoryOverload

    string

    AdminMonitor

    integer

    KeyboardControl

    string

    AdminKeyboardOnWindows

    string

    AdminKeyboardOnFullScreen

    string

    NetworkPrinter

    string

    EndUserCount

    string

    OrganizationCount

    string

    ResetDesktop

    string

    DeviceConnectHint

    string

    FileMigrate

    string

    WuyingKeeper

    string

    AutoReconnect

    string

    Examples

    Success response

    JSON format

    {
  "TotalCount": 20,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "DescribePolicyGroups": [
    {
      "PolicyStatus": "AVAILABLE",
      "Html5Access": "off",
      "WatermarkType": "EndUserId",
      "WatermarkCustomText": "custom-watermark",
      "Clipboard": "off",
      "PolicyGroupId": "pg-gx2x1dhsmthe9****",
      "PrinterRedirection": "off",
      "Html5FileTransfer": "off",
      "UsbRedirect": "off",
      "PolicyGroupType": "SYSTEM",
      "Watermark": "on",
      "VisualQuality": "medium",
      "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"
        }
      ],
      "GpuAcceleration": "off",
      "UsbSupplyRedirectRule": [
        {
          "VendorId": "04**",
          "ProductId": "08**",
          "Description": "测试规则",
          "UsbRedirectType": 1,
          "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": "tcp",
      "VideoRedirect": "off",
      "WatermarkTransparencyValue": 10,
      "WatermarkColor": 0,
      "WatermarkFontSize": 10,
      "WatermarkFontStyle": "plain",
      "WatermarkDegree": -10,
      "WatermarkRowAmount": 3,
      "EndUserApplyAdminCoordinate": "off",
      "EndUserGroupCoordinate": "off",
      "CpuProtectedMode": "on",
      "CpuRateLimit": 70,
      "CpuSampleDuration": 10,
      "CpuSingleRateLimit": 70,
      "CpuDownGradeDuration": 30,
      "CpuProcessors": [
        "chrome.exe"
      ],
      "MemoryProtectedMode": "off",
      "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": 2000,
      "DeviceRedirects": [
        {
          "DeviceType": "camera",
          "RedirectType": "usbRedirect"
        }
      ],
      "DeviceRules": [
        {
          "DeviceType": "storage",
          "DeviceName": "sandisk",
          "DeviceVid": "0x0781",
          "DevicePid": "0x55b1",
          "RedirectType": "usbRedirect",
          "OptCommand": "2:0",
          "Platforms": ""
        }
      ],
      "WyAssistant": "on",
      "StatusMonitor": "on",
      "MobileRestart": "off",
      "MobileShutdown": "off",
      "DesktopCount": 1,
      "DesktopGroupCount": 1,
      "ResourceGroupCount": 1,
      "ResolutionModel": "adaptive",
      "ResolutionWidth": 1920,
      "ResolutionHeight": 1280,
      "Taskbar": "off",
      "NoOperationDisconnect": "off",
      "NoOperationDisconnectTime": 120,
      "DisconnectKeepSession": "persistent",
      "DisconnectKeepSessionTime": 120,
      "DomainRegisterValue": "xxxx",
      "RecordEventFilePaths": [
        "d:/data"
      ],
      "RecordEventRegisters": [
        "计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR"
      ],
      "RecordEventDuration": 10,
      "InternetPrinter": "",
      "SafeMenu": "",
      "ScreenDisplayMode": "",
      "ClientControlMenu": "",
      "FileTransferSpeedLocation": "",
      "FileTransferAddress": "",
      "FileTransferSpeed": "",
      "CpdDriveClipboard": "",
      "UseTime": "",
      "ResolutionDpi": 0,
      "HoverConfigMsg": "",
      "ClientHibernate": "",
      "ClientRestart": "",
      "ClientShutdown": "",
      "HoverHibernate": "",
      "HoverRestart": "",
      "HoverShutdown": "",
      "MultiScreen": "",
      "AcademicProxy": "",
      "ModelLibrary": "",
      "PortProxy": "",
      "WatermarkShadow": "",
      "MobileWyAssistant": "",
      "MobileSafeMenu": "",
      "MobileWuyingKeeper": "",
      "ExternalDrive": "",
      "KmsServerConfig": "",
      "KmsServer": "",
      "ClientCreateSnapshot": "",
      "DiskOverload": "",
      "CpuOverload": "",
      "MemoryOverload": "",
      "AdminMonitor": 0,
      "KeyboardControl": "",
      "AdminKeyboardOnWindows": "",
      "AdminKeyboardOnFullScreen": "",
      "NetworkPrinter": "",
      "EndUserCount": "",
      "OrganizationCount": ""
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.