All Products
Search
Document Center

Elastic Desktop Service:DescribeCenterPolicyList

Last Updated:Nov 14, 2025

Queries center policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:DescribeCenterPolicyListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number.
Default value: 1.

1
PageSizeintegerNo

The number of entries per page.

20
PolicyGroupIdarrayNo

The IDs of the cloud computer policies.

stringNo

The ID of the cloud computer policy.

pg-53iyi2aar0nd6****
ScopestringNo

The effective scope of the cloud computer policy.

Valid values:

  • IP: The policy applies to specific IP addresses.
  • GLOBAL: The policy applies globally.
GLOBAL
BusinessTypeintegerYes

The business type.

Valid values:

  • 1: public cloud
  • 8: commercial edition.
1
ResourceTypestringYes

The resource type.

Valid values:

  • app: cloud applications.
  • desktop: cloud computers.
desktop

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

20
RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DescribePolicyGroupsarray<object>

The details about the cloud computer policies.

DescribePolicyGroupobject

The details about the cloud computer policy.

PolicyStatusstring

The status of the cloud computer policy.

AVAILABLE
Html5Accessstring

The web client access policy.

off
WatermarkTypestring

The watermark type.

EndUserId
WatermarkCustomTextstring

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

custom-watermark
Clipboardstring

The read/write permissions on the clipboard.

off
PolicyGroupIdstring

The policy ID.

pg-gx2x1dhsmthe9****
PrinterRedirectionstring

The printer redirection policy.

off
Html5FileTransferstring

The file transfer feature on the web client.

off
UsbRedirectstring

The USB redirection policy.

off
PolicyGroupTypestring

The type of the policy.

SYSTEM
Watermarkstring

The watermark policy.

on
VisualQualitystring

The image quality policy.

medium
Namestring

The policy name.

testPolicyGroupName
LocalDrivestring

The read/write permissions on the on-premises drive.

readwrite
AuthorizeSecurityPolicyRulesarray<object>

The security group rules.

AuthorizeSecurityPolicyRuleobject

The security group rule.

Typestring

The direction of the security group rule.

inflow
Policystring

The authorization policy of the security group rule.

accept
Descriptionstring

The description of the security group rule.

test
PortRangestring

The port range of the security group rule.

22/22
IpProtocolstring

The protocol type of the security group rule.

tcp
Prioritystring

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

1
CidrIpstring

The object to which the security group rule applies. The value is an IPv4 CIDR block.

47.100.XX.XX/16
AuthorizeAccessPolicyRulesarray<object>

The client IP address whitelists.

AuthorizeAccessPolicyRuleobject

The client IP address whitelist.

Descriptionstring

The remarks on the client CIDR block.

test
CidrIpstring

The client CIDR block from which end users can connect to cloud computers. The value is an IPv4 CIDR block.

47.100.XX.XX/16
ClientTypesarray<object>

The logon method control rules.

ClientTypeobject

The logon method control rule.

Statusstring

Indicates whether a specific client type can connect to cloud computers.

on
ClientTypestring

The client type.

windows
GpuAccelerationstring

Indicates whether image quality control is enabled. For optimal computer performance and user experience in professional design scenarios, we recommend enabling this feature.

off
UsbSupplyRedirectRulearray<object>

The USB redirection rules.

UsbSupplyRedirectRuleobject

The USB redirection rule.

VendorIdstring

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

04**
ProductIdstring

The product ID (PID).

08**
Descriptionstring

The rule description.

UsbRedirectTypelong

Indicates whether USB redirection is allowed.

1
UsbRuleTypelong

The type of the USB redirection rule.

1
DomainResolveRuleTypestring

Indicates whether domain name resolution is allowed.

on
DomainResolveRulearray<object>

The domain resolution policies.

DomainResolveRuleobject

The domain resolution policy.

Domainstring

The domain name.

*.example.com
Policystring

The resolution policy.

allow
Descriptionstring

The policy description.

NetRedirectRulearray<object>

The network redirection policies.

Note This parameter is in private preview and only available to specific users.
NetRedirectRuleobject

The network redirection policy.

Note This parameter is in private preview and only available to specific users.
Domainstring

The domain name.

*.example.com
RuleTypestring

The rule type.

domain
Policystring

The redirection policy.

allow
Recordingstring

Indicates whether screen recording is enabled.

off
RecordingStartTimestring

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

08:00:00
RecordingEndTimestring

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

08:59:00
RecordingFpslong

The frame rate of screen recording. Unit: fps.

5
RecordingExpireslong

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

15
CameraRedirectstring

Indicates whether on-premises webcam redirection is enabled.

on
NetRedirectstring

The network redirection policy.

Note This parameter is in private preview and only available to specific users.
off
AppContentProtectionstring

Indicates whether anti-screenshot is enabled.

off
RecordContentstring

Indicates whether custom screen recording is enabled.

off
RecordContentExpireslong

The duration for which custom screen recordings are kept before they expire. Default value: 30 days.

30
RemoteCoordinatestring

The keyboard and mouse control permissions during remote assistance.

fullControl
RecordingDurationinteger

The length of the screen recording file. Unit: minutes. Screen recording files are split by the specified length and uploaded to OSS buckets. Once a file reaches 300 MB, the system prioritizes rolling updates for that file.

10
Scopestring

The effective scope of the policy.

GLOBAL
ScopeValuearray

The effective scopes specified by CIDR blocks.

scopeValuestring

The effective scope specified by a CIDR block.

47.100.XX.XX/24
RecordingAudiostring

Indicates whether audio files generated on cloud computers are recorded.

on
InternetCommunicationProtocolstring

The network communication protocol.

tcp
VideoRedirectstring

Indicates whether multimedia redirection is enabled.

off
WatermarkTransparencyValueinteger

The watermark transparency. A higher value means the watermark is less transparent. Valid values: 10 to 100.

10
WatermarkColorinteger

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

0
WatermarkFontSizeinteger

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

10
WatermarkFontStylestring

The font style of the watermark.

plain
WatermarkDegreedouble

The watermark rotation. Valid values: -10 to -30.

-10
WatermarkRowAmountinteger

The number of watermark rows.

3
EndUserApplyAdminCoordinatestring

Indicates whether end users are allowed to request administrator help.

off
EndUserGroupCoordinatestring

Indicates whether end users in the same office network can share cloud computers.

off
CpuProtectedModestring

The CPU spike protection policy.

on
CpuRateLimitinteger

The overall CPU usage. Valid values: 70 to 90. Unit: percentage (%).

70
CpuSampleDurationinteger

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

10
CpuSingleRateLimitinteger

The single-CPU usage. Valid values: 70 to 100. Unit: %.

70
CpuDownGradeDurationinteger

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

30
CpuProcessorsarray

The CPU processors.

cpuProcessorstring

The CPU processor.

chrome.exe
MemoryProtectedModestring

The memory spike protection policy.

off
MemoryRateLimitinteger

The overall memory usage. Valid values: 70 to 90. Unit: %.

70
MemorySampleDurationinteger

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

30
MemorySingleRateLimitinteger

The memory usage per process. Valid values: 30 to 60. Unit: %.

30
MemoryDownGradeDurationinteger

The memory underclocking duration per process. Valid values: 30 to 120. Unit: seconds.

30
MemoryProcessorsarray

The memory processors.

memoryProcessorstring

The memory processor.

notepad.exe
WatermarkSecuritystring

Indicates whether security priority is enabled for invisible watermarks.

on
WatermarkAntiCamstring

Indicates whether anti-screen capture is enabled for invisible watermarks.

off
WatermarkPowerstring

The enhancement level for invisible watermarks.

medium
RecordingUserNotifystring

Indicates whether to notify end users when screen recording is enabled.

off
RecordingUserNotifyMessagestring

The notification sent to end users when screen recording is enabled.

AdminAccessstring

Indicates whether the admin permissions are granted to end users.

Note This parameter is in private preview and only available to specific users.
deny
MaxReconnectTimeinteger

The maximum duration to retry reconnecting to cloud computers after an unexpected disconnection (non-human causes). Valid values: 30 to 7200. Unit: seconds.

120
DisplayModestring

The display mode.

adminCustom
StreamingModestring

The streaming mode.

smooth
ColorEnhancementstring

Indicates whether color enhancement is enabled for design and 3D applications.

off
SmoothEnhancementstring

Indicates whether smoothness enhancement is enabled for daily office use.

off
QualityEnhancementstring

Indicates whether image quality enhancement is enabled for design and 3D applications.

off
VideoEncPolicystring

The video encoding policy.

qualityFirst
TargetFpsinteger

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

30
VideoEncMinQPinteger

The minimum quantizer parameter (QP) for video files. A lower QP means better video quality. Valid values: 0 to 51.

20
VideoEncMaxQPinteger

The maximum QP for video files. Higher QP values result in lower video quality. Valid values: 0 to 51.

20
VideoEncAvgKbpsinteger

The average bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.

1000
VideoEncPeakKbpsinteger

The peak bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.

2000
DeviceRedirectsarray<object>

The device redirection rules.

DeviceRedirectobject

The device redirection rule.

DeviceTypestring

The peripheral type.

camera
RedirectTypestring

The redirection type.

usbRedirect
DeviceRulesarray<object>

The custom peripheral rules.

DeviceRuleobject

The custom peripheral rule.

DeviceTypestring

The peripheral type.

storage
DeviceNamestring

The device name.

sandisk
DeviceVidstring

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

0x0781
DevicePidstring

The product ID (PID).

0x55b1
RedirectTypestring

The redirection type.

usbRedirect
OptCommandstring

The link optimization command.

2:0
WyAssistantstring

Indicates whether the Xiaoying AI Assistant entry is displayed in the DesktopAssistant menu.

on
StatusMonitorstring

Indicates whether the metric status entry is displayed in the DesktopAssistant menu.

on
MobileRestartstring

Indicates whether the Restart button is displayed in the DesktopAssistant menu when end users connect to cloud computers from Android clients.

Note This feature applies to only mobile clients of version 7.4.0 or later.
off
MobileShutdownstring

Indicates whether the Stop button is displayed in the DesktopAssistant menu when end users connect to cloud computers from Android clients.

Note This feature applies to only mobile clients of version 7.4.0 or later.
off
DesktopCountinteger

The number of cloud computers that are associated with the policy.

1
DesktopGroupCountinteger

The number of cloud computer shares that are associated with the policy.

1
ResourceGroupCountinteger

The number of resource groups that are associated with the policy.

1
ResolutionModelstring

The resolution type.

adaptive
ResolutionWidthinteger

The width of the resolution. Unit: pixel.

1920
ResolutionHeightinteger

The height of the resolution. Unit: pixel.

1280
Taskbarstring

Indicates whether the application taskbar is displayed.

Note This parameter applies only to cloud application policies.
off
NoOperationDisconnectstring

Indicates whether a disconnection is enforced upon inactivity.

Note This parameter applies only to cloud application policies.
off
NoOperationDisconnectTimeinteger

The duration of disconnection after inactivity. Unit: seconds.

Note This parameter applies only to cloud application policies.
120
DisconnectKeepSessionstring

Indicates whether the session is retained after disconnection.

Note This parameter applies only to cloud application policies.
persistent
DisconnectKeepSessionTimeinteger

The retention period of the session after disconnection. Unit: seconds.

Note This parameter applies only to cloud application policies.
120
DomainRegisterValuestring

The field where the domain resolution policy is applied.

xxxx
RecordEventFilePathsarray

The absolute paths to screen recording files.

recordEventFilePathstring

The absolute path to the screen recording file.

d:/data
RecordEventRegistersarray

The absolute paths to screen recording registries.

recordEventRegisterstring

The absolute path to the screen recording registry.

RecordEventDurationinteger

The duration of screen recording after the specified event is detected. Unit: minutes. Valid values: 10 to 60.

10

Examples

Sample success responses

JSONformat

{
  "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": [
        ""
      ],
      "RecordEventDuration": 10,
      "InternetPrinter": "",
      "SafeMenu": "",
      "ScreenDisplayMode": "",
      "ClientControlMenu": "",
      "FileTransferSpeedLocation": "",
      "FileTransferAddress": "",
      "FileTransferSpeed": "",
      "CpdDriveClipboard": "",
      "UseTime": ""
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.