DocsICP FilingConsole
官方文档
首页

CreateCenterPolicy

更新时间：
复制 MD 格式
产品详情
我的收藏

You can create a region-independent cloud desktop 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:CreateCenterPolicy

none

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

Yes

Region ID. This feature is region-independent. Set this parameter to cn-shanghai.

Valid values:

  • cn-shanghai :

    China (Shanghai)

cn-shanghai
ResourceType

string

Yes

Resource type.

Valid values:

  • app :

    Cloud application

  • desktop :

    Cloud desktop

desktop
BusinessType

integer

Yes

Business type.

Valid values:

  • 1 :

    Public cloud

  • 8 :

    Commercial edition

1
Clipboard

string

No

Clipboard permission.

Valid values:

  • read :

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

  • readwrite :

    Two-way allowed. You can copy local content to the cloud desktop and copy cloud desktop content to the local device.

  • write :

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

  • off :

    Two-way disabled. Copy operations between the cloud desktop and the local device are not allowed. [Default value]

off
LocalDrive

string

No

Local disk mapping permission.

Valid values:

  • read :

    Read-only. The cloud desktop maps the local disk, but you can only read (copy) local files and cannot modify them.

  • readwrite :

    Read-write. The cloud desktop maps the local disk. You can read (copy) and modify local files.

  • off :

    Disabled. The cloud desktop does not map the local disk. [Default value]

off
UsbRedirect

string

No

USB redirection.

Valid values:

  • off :

    Disabled [Default value]

  • on :

    Enabled

off
PrinterRedirect

string

No

Printer redirection policy. This parameter takes effect only when no printer redirection policy is configured in DeviceRedirects.

Valid values:

  • deviceRedirect :

    Device redirection [Default value]

  • usbRedirect :

    USB redirection

  • off :

    Disabled

off
VisualQuality

string

No

Image display quality policy.

Valid values:

  • high :

    High definition

  • low :

    Low definition

  • lossless :

    Lossless

  • medium :

    Automatic rotation [Default value]

low
GpuAcceleration

string

No

Enable image quality policy for graphics-intensive cloud desktops. Enable this policy if you require high performance and user experience, such as in professional design scenarios.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
Html5FileTransfer

string

No

Web client file transfer policy.

Valid values:

  • all :

    Allow upload and download

  • download :

    Allow download

  • upload :

    Allow upload

  • off :

    Disabled [Default value]

off
Watermark

string

No

Watermark.

Valid values:

  • blind :

    Enable blind watermark

  • off :

    Disable watermark [Default value]

  • on :

    Enable visible watermark

off
Name

string

Yes

Policy name.

testPolicyGroupName
WatermarkType

string

No

Watermark type. You can select up to three types, separated by commas.

Note

If you set this parameter to custom, you must also specify custom text using the WatermarkCustomText parameter.

Valid values:

  • EndUserId :

    Username

  • Custom :

    Custom text

  • DesktopIp :

    Cloud desktop IP address

  • ClientIp :

    Client IP address

  • HostName :

    Last 15 characters of the cloud desktop ID

  • ClientTime :

    Current time on the cloud desktop

EndUserId,HostName,ClientTime
WatermarkCustomText

string

No

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

test
WatermarkTransparencyValue

integer

No

Watermark opacity. A higher value indicates lower transparency. Valid values: 10 to 100.

10
WatermarkSecurity

string

No

Blind watermark security priority rule.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

on
CameraRedirect

string

No

Local camera redirection. This parameter takes effect only when no local camera redirection policy is configured in DeviceRedirects.

Valid values:

  • deviceRedirect :

    Device redirection

  • off :

    Disabled

off
NetRedirect

string

No

Enable network redirection.

Note

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

Valid values:

  • all :

    Enable global mode

  • off :

    Disabled [Default value]

  • on :

    Enable whitelist mode

off
AppContentProtection

string

No

Enable screenshot prevention.

Valid values:

  • off :

    Disabled [Default value]

  • on :

    Enabled

off
RemoteCoordinate

string

No

Mouse and keyboard control permissions during remote assistance.

Valid values:

  • optionalControl :

    Disabled by default (can be enabled upon request)

  • fullControl :

    Full control

  • disableControl :

    No control

fullControl
InternetCommunicationProtocol

string

No

Network communication protocol.

Valid values:

  • tcp :

    TCP mode applies to scenarios where UDP/AST is restricted.

  • rtc :

    AST mode applies to audio and video scenarios with frequent usage.

  • auto :

    AUTO mode automatically switches between AST and UDP modes based on desktop content.

  • both :

    UDP mode applies to office and high-definition graphic design scenarios.

both
VideoRedirect

string

No

Multimedia redirection.

Valid values:

  • off :

    Disable media redirection

  • on :

    Enable media redirection

on
WatermarkColor

integer

No

Watermark font color. Valid values: 0 to 16777215.

0
WatermarkDegree

number

No

Watermark tilt angle. Valid values: -10 to -30.

-10
WatermarkFontSize

integer

No

Watermark font size. Valid values: 10 to 20.

10
WatermarkFontStyle

string

No

Watermark font style.

Valid values:

  • plain :

    Plain

  • bold :

    Bold

plain
WatermarkRowAmount

integer

No

Number of watermark rows. Valid values: 3 to 10.

3
WatermarkColumnAmount

integer

No

Number of watermark columns. Valid values: 3 to 10.

3
CpuProtectedMode

string

No

CPU protection mode switch.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
CpuRateLimit

integer

No

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

70
CpuSampleDuration

integer

No

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

60
CpuSingleRateLimit

integer

No

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

70
CpuDownGradeDuration

integer

No

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

30
MemoryProtectedMode

string

No

Memory protection mode switch.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
MemoryRateLimit

integer

No

Memory overall usage percentage. Valid values: 70 to 90.

70
MemorySampleDuration

integer

No

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

40
MemorySingleRateLimit

integer

No

Memory usage percentage per worker. Valid values: 30 to 60.

40
MemoryDownGradeDuration

integer

No

Memory downclocking duration per worker. Valid values: 30 to 120. Unit: seconds.

40
EndUserApplyAdminCoordinate

string

No

User requests administrator assistance.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
EndUserGroupCoordinate

string

No

Users in the same office network share cloud desktops.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
Scope

string

No

Policy scope.

Valid values:

  • IP :

    Effective for specified IP addresses

  • GLOBAL :

    Globally effective

GLOBAL
Recording

string

No

Enable screen recording.

Valid values:

  • period :

    Periodic recording

  • session :

    Session recording

  • off :

    Disabled

  • alltime :

    Continuous recording

off
RecordingAudio

string

No

Options for recording cloud desktop audio.

Valid values:

  • off :

    Record video only

  • on :

    Record system and peripheral audio

on
RecordingStartTime

string

No

Screen recording start time. Format: HH:MM:SS. This parameter takes effect only when Recording is set to PERIOD.

08:00:00
RecordingEndTime

string

No

Screen recording end time. Format: HH:MM:SS. This parameter takes effect only when Recording is set to PERIOD.

08:59:00
RecordingFps

string

No

Screen recording frame rate. Unit: FPS.

2
RecordingDuration

integer

No

Duration for viewing recorded files. Unit: minutes. Recorded files are automatically split and uploaded to the bucket based on the specified duration. When a file reaches 300 MB, it is rolled over for updates. Valid values: 10 to 60.

10
RecordingExpires

integer

No

Retention period for recorded files. Valid values: 1 to 180 days.

15
RecordingUserNotify

string

No

Notify end users that screen recording is enabled.

Valid values:

  • off :

    Do not notify users about screen recording

  • on :

    Notify users that screen recording will be enabled

off
RecordingUserNotifyMessage

string

No

Message to notify end users that screen recording is enabled.

录屏已开启
AdminAccess

string

No

Whether users have administrative permission after logging on to cloud desktops.

Note

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

Valid values:

  • allow :

    Force allow

  • deny :

    Force deny

  • inherited :

    Inherit administrative permission control from the user dimension

deny
EnableSessionRateLimiting

string

No

Session bandwidth throttling.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
SessionMaxRateKbps

integer

No

Maximum session bandwidth throttling rate. Unit: Kbps. Valid values: 2000 to 100000.

2000
DisplayMode

string

No

Display mode.

Valid values:

  • clientCustom :

    User-configurable

  • adminOffice :

    Daily office scenario

  • adminDesign :

    Design and 3D applications

  • adminCustom :

    Custom

clientCustom
StreamingMode

string

No

Streaming mode adaptation scenario.

Valid values:

  • intelligent :

    Intelligent mode

  • smooth :

    Smoothness priority

smooth
ColorEnhancement

string

No

Enable color enhancement for design and 3D application scenarios.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
SmoothEnhancement

string

No

Enable smoothness enhancement for daily office scenarios.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
QualityEnhancement

string

No

Enable image quality enhancement for design and 3D application scenarios.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
VideoEncPolicy

string

No

Video encoding policy.

Valid values:

  • qualityFirst :

    Quality priority

  • bandwidthFirst :

    Bandwidth priority

qualityFirst
TargetFps

integer

No

Target frame rate. Valid values: 10 to 60.

30
VideoEncMinQP

integer

No

Minimum QP for video encoding, representing the highest quality. Valid values: 0 to 51.

30
VideoEncMaxQP

integer

No

Maximum QP for video encoding, representing the lowest image quality. Valid values: 0 to 51.

30
VideoEncAvgKbps

integer

No

Average video encoding bitrate. Unit: Kbps. Valid values: 1000 to 50000.

2000
VideoEncPeakKbps

integer

No

Peak video encoding bitrate. Unit: Kbps. Valid values: 1000 to 50000.

2000
MaxReconnectTime

integer

No

Maximum reconnection retry time when a cloud desktop disconnects due to objective reasons. Valid values: 30 to 7200. Unit: seconds.

120
WyAssistant

string

No

Provide an entry point for Wuying AI Assistant in the floating ball on the cloud desktop when connecting through desktop clients (including Windows and macOS clients).

Note

This feature applies only to desktop clients V7.7 or later.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

on
CpuProcessors

array

No

The name of the process.

string

No

Process name.

notepad.exe
MemoryProcessors

array

No

Process names.

string

No

Process name.

chrome.exe
DomainResolveRule

array<object>

No

Domain name resolution policy.

object

No

Details of the domain name resolution policy.

Domain

string

No

Domain name.

*.example.com
Policy

string

No

Resolution policy.

Valid values:

  • allow :

    Allow

  • block :

    Deny

allow
Description

string

No

Policy description.

测试规则
NetRedirectRule

array<object>

No

Network redirection policy details.

Note

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

object

No

Network redirection policy details.

Note

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

Domain

string

No

Domain name.

*.example.com
RuleType

string

No

Rule type.

Valid values:

  • prc :

    Process

  • domain :

    Domain

domain
Policy

string

No

Redirection policy.

allow
ScopeValue

array

No

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

string

No

Effective CIDR block range.

47.100.XX.XX/24
ClientType

array<object>

No

List of logon method control rules. These rules control which clients can access cloud desktops.

object

No

Logon method control rule.

Status

string

No

Logon method control. Specify whether to allow users to log on to cloud desktops using a specific type of client.

Note

If you do not configure parameters related to ClientType, all types of clients are allowed to log on to cloud desktops by default.

Valid values:

  • off :

    Not allowed

  • on :

    Allowed

off
ClientType

string

No

Logon method control. Specify the client type.

Valid values:

  • html5 :

    Web client

  • android :

    Android client

  • ios :

    iOS client

  • windows :

    Windows client

  • macos :

    macOS client

windows
UsbSupplyRedirectRule

array<object>

No

USB redirection rules.

object

No

USB redirection rules.

VendorId

string

No

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

04**
UsbRuleType

string

No

USB redirection rule type.

Valid values:

  • 2 :

    Product

2
Description

string

No

Rule description.

测试规则
UsbRedirectType

string

No

USB redirection type.

Valid values:

  • 1 :

    Allow

  • 2 :

    Deny

1
ProductId

string

No

Product ID.

08**
AuthorizeSecurityPolicyRule

array<object>

No

List of security group control rules.

object

No

List of security group control rules.

Type

string

No

Direction of the security group control rule.

Valid values:

  • outflow :

    Outbound

  • inflow :

    Inbound

inflow
Policy

string

No

Authorization policy of the security group control rule.

Valid values:

  • drop :

    Deny policy. Denies all access requests without returning a denial message. Requests time out or fail to establish connections from the requester VPC.

  • accept :

    Allow policy. Accepts all access requests. [Default value]

accept
PortRange

string

No

Port range of the security group control rule. The port range depends on the protocol (IpProtocol):

  • TCP or UDP: Port range is 1 to 65535. Separate the start and end ports with a forward slash (/). Example: 1/200.

  • ICMP: Port is -1/-1.

  • GRE: Port is -1/-1.

  • IpProtocol is all: Port is -1/-1.

For common ports used by typical applications, see Common ports.

22/22
Description

string

No

Description of the security group control rule.

test
IpProtocol

string

No

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

No

Priority of the security group control rule. A smaller number indicates a higher priority.
Valid values: 1 to 60.
Default value: 1.

1
CidrIp

string

No

Object of the security group control rule. IPv4 CIDR block.

10.0.XX.XX/8
AuthorizeAccessPolicyRule

array<object>

No

Client IP address whitelist. After this parameter is configured, only IP addresses within the specified CIDR blocks can access cloud desktops.

object

No

Client IP address whitelist.

Description

string

No

Description of the client IP address whitelist.

test
CidrIp

string

No

Client access IP address range. IPv4 CIDR block.

47.100.XX.XX/16
DeviceRedirects

array<object>

No

List of device redirection rules.

object

No

List of device redirection rules.

RedirectType

string

No

Redirection type.

Valid values:

  • deviceRedirect :

    Device redirection

  • usbRedirect :

    USB redirection

  • off :

    Disabled

usbRedirect
DeviceType

string

No

Device type

Valid values:

  • printer :

    Printer

  • scanner :

    Scanner

  • serialport :

    Serial port device

  • camera :

    Camera

  • adb :

    ADB

camera
DeviceRules

array<object>

No

List of custom peripheral rules.

object

No

List of custom peripheral rules.

DeviceName

string

No

Device name.

sandisk
RedirectType

string

No

Redirection type.

Valid values:

  • deviceRedirect :

    Device redirection

  • usbRedirect :

    USB redirection

  • off :

    Prohibited

usbRedirect
DeviceType

string

No

Peripheral type.

Valid values:

  • usbKey :

    UKey

  • other :

    Other

  • graphicsTablet :

    Graphics tablet

  • cardReader :

    Card reader

  • printer :

    Printer

  • scanner :

    Scanner

  • storage :

    Storage device

  • camera :

    Camera

  • networkInterfaceCard :

    Network interface controller (NIC)

storage
OptCommand

string

No

Link optimization command.

2:0
DevicePid

string

No

Product ID.

0x55b1
DeviceVid

string

No

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

0x0781
Platforms

string

No

WatermarkAntiCam

string

No

Blind watermark anti-photo feature.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
WatermarkPower

string

No

Blind watermark enhancement feature.

Valid values:

  • high :

    High

  • low :

    Low

  • medium :

    Medium

medium
DomainResolveRuleType

string

No

Domain name resolution policy type.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
ClipboardScope

string

No

Clipboard scope

GLOBAL
ClipboardGraineds

array<object>

No

Fine-grained clipboard control configuration

object

No

GrainedType

string

No

ClipboardType

string

No

ClipboardSize

integer

No

ClipboardSizeUnit

string

No

InClipboardSize

integer

No

InClipboardSizeUnit

string

No

OutClipboardSize

integer

No

OutClipboardSizeUnit

string

No

StatusMonitor

string

No

Provide an entry point for status monitoring in the floating ball on the cloud desktop.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
MobileRestart

string

No

Provide a restart button in the floating ball on the cloud desktop when connecting through mobile clients (Android and iOS clients).

Note

This feature applies only to mobile clients V7.4 or later.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
MobileShutdown

string

No

Provide a shutdown button in the floating ball on the cloud desktop when connecting through mobile clients (Android and iOS clients).

Note

This feature applies only to mobile clients V7.4 or later.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
ResolutionModel

string

No

Resolution type.

Valid values:

  • adaptive :

    Adaptive resolution

  • customer :

    Fixed resolution

adaptive
ResolutionWidth

integer

No

Resolution width. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 640 to 4096.

720
ResolutionHeight

integer

No

Resolution height. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 480 to 4096.

1280
Taskbar

string

No

Application taskbar.

Note

This parameter applies only to cloud application policies.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
NoOperationDisconnect

string

No

Disconnect on inactivity.

Note

This parameter applies only to cloud application policies.

Valid values:

  • off :

    Disabled

  • on :

    Enabled

off
NoOperationDisconnectTime

integer

No

Inactivity disconnect duration. Valid values: 120 to 7200. Unit: seconds.

Note

This parameter applies only to cloud application policies.

120
DisconnectKeepSession

string

No

Session retention after disconnection.

Note

This parameter applies only to cloud application policies.

Valid values:

  • customTime :

    Fixed time

  • persistent :

    Persistent

customTime
DisconnectKeepSessionTime

integer

No

Session retention duration after disconnection. Valid values: 30 to 7200. Unit: seconds.

Note

This parameter applies only to cloud application policies.

30
RecordEvents

array

No

List of screen recording events.

string

No

Screen recording event.

Valid values:

  • transferWithLocal :

    Clipboard and file transfer operations

  • userInput :

    User input

  • usbRedirect :

    USB peripheral plug and unplug

transferWithLocal
RecordEventFilePaths

array

No

Absolute paths of files to monitor in screen recording audit.

string

No

Absolute path of the file to monitor in screen recording audit.

C://test.txt
RecordEventRegisters

array

No

Absolute paths of registry keys to monitor in screen recording audit.

string

No

Absolute path of the registry key to monitor in screen recording audit.

计算机\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\USBSTOR
RecordEventDuration

integer

No

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

10
ResetDesktop

string

No

Reset cloud desktop.

off
DeviceConnectHint

string

No

Peripheral connection hint control.

off
FileMigrate

string

No

File migration.

off
WuyingKeeper

string

No

Wuying Keeper switch.

off
InternetPrinter

string

No

SafeMenu

string

No

ScreenDisplayMode

string

No

ClientControlMenu

string

No

FileTransferSpeedLocation

string

No

FileTransferSpeed

string

No

FileTransferAddress

string

No

CpdDriveClipboard

string

No

UseTime

string

No

AutoReconnect

string

No

Client auto-reconnect switch

off
MobileWuyingKeeper

string

No

Mobile Wuying Keeper switch

off
MobileSafeMenu

string

No

Mobile Windows security control switch

off
MobileWyAssistant

string

No

Mobile Xiao Ying switch

off
RecordEventLevels

array<object>

No

Levels of screen recording events

object

No

EventType

string

No

Event type

StartApplication
EventLevel

string

No

Event level

HIGH
RecordEventFileExts

array

No

File name extensions for screen recording events

string

No

txt
ExternalDrive

string

No

WatermarkShadow

string

No

ClientCreateSnapshot

string

No

AcademicProxy

string

No

ModelLibrary

string

No

PortProxy

string

No

BusinessChannel

string

No

DiskOverload

string

No

CpuOverload

string

No

MemoryOverload

string

No

ResolutionDpi

integer

No

HoverConfigMsg

string

No

MultiScreen

string

No

KeyboardControl

string

No

AdminKeyboardOnWindows

string

No

AdminKeyboardOnFullScreen

string

No

Description

string

No

Response elements

Element

Type

Description

Example

object

PolicyGroupId

string

Cloud desktop policy ID.

pg-gx2x1dhsmthe9****
RequestId

string

Request ID.

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

Examples

Success response

JSON format

{
  "PolicyGroupId": "pg-gx2x1dhsmthe9****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.