Creates a cloud computer policy.
Operation description
A policy is a set of security rules that are used to control security configurations when end users use cloud desktops. A policy contains basic features, such as USB redirection and watermarking, and other features, such as security group control. For more information, see Policy overview.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region. | cn-hangzhou |
Clipboard | string | No | The permissions on the clipboard. Valid values:
| off |
LocalDrive | string | No | The permissions on local disk mapping. Valid values:
| off |
UsbRedirect | string | No | Specifies whether to enable USB redirection. Valid values:
| off |
VisualQuality | string | No | The policy for image display quality. Valid values:
| medium |
Html5Access | string | No | The policy for HTML5 client access. Note
We recommend that you use the ClientType parameter to manage the type of Alibaba Cloud Workspace clients for desktop connection.
Valid values:
| off |
Html5FileTransfer | string | No | The file transfer policy for HTML5 clients. Valid values:
| off |
Watermark | string | No | Specifies whether to enable watermarking. Valid values:
| off |
Name | string | No | The name of the policy. | testPolicyGroupName |
WatermarkType | string | No | The type of the watermark. You can specify multiple types of watermarks at the same time. Separate multiple watermark types with commas (,). Valid values:
| EndUserId |
WatermarkTransparency | string | No | The transparency of the watermark. Valid values:
| LIGHT |
PreemptLogin | string | No | Specifies whether to allow user preemption. Note
To improve user experience and ensure data security, multiple end users cannot connect to the same cloud desktop at the same time. The default value of this parameter is off , and the value cannot be changed.
| off |
DomainList | string | No | Access control for domain names. The wildcard character (*) is supported for domain names. Separate multiple domain names with commas (,). Valid values:
| off |
PrinterRedirection | string | No | The policy for printer redirection. Valid values:
| on |
PreemptLoginUser | array | No | The names of the users that are allowed to connect to the same cloud desktop at the same time. You can specify up to five usernames. Note
To improve user experience and ensure data security, we recommend that you disable the user preemption feature.
| |
string | No | The name of the end user that is allowed to connect to a cloud desktop to which another end user is connected. | Alice | |
AuthorizeSecurityPolicyRule | array<object> | No | The security group rules. | |
object | No | The security group rule. | ||
Type | string | No | The direction of the security group rule. Valid values:
| inflow |
Policy | string | No | The authorization policy of the security group rule. Valid values:
| accept |
PortRange | string | No | The port range of the security group rule. The value range of this parameter varies based on the value of the IpProtocol parameter.
For more information about the common ports of applications, see Common ports. | 22/22 |
Description | string | No | The description of the security group rule. | test |
IpProtocol | string | No | The protocol type of the security group rule. Valid values:
| tcp |
Priority | string | No | The priority of the security group rule. A smaller value specifies a higher priority. | 1 |
CidrIp | string | No | The IPv4 CIDR block of the security group rule. | 47.100.XX.XX/16 |
AuthorizeAccessPolicyRule | array<object> | No | The client IP address whitelists. Only the client IP addresses in whitelists can access the cloud desktop. | |
object | No | The client IP address whitelist. | ||
Description | string | No | The description of the client IP address whitelist. | North China Branch |
CidrIp | string | No | The IPv4 CIDR block that you want to access from the client. The value is an IPv4 CIDR block. | 47.100.XX.XX/16 |
ClientType | array<object> | No | The logon methods. You can use this parameter to determine which clients can be used to connect to the cloud desktop. | |
object | No | The logon method. | ||
Status | string | No | Specifies whether a specific client type can be used to connect to the cloud desktop. Note
By default, if you do not specify the ClientType parameter, all types of clients can be used to connect to cloud desktops.
Valid values:
| ON |
ClientType | string | No | The type of the client. Note
By default, if you do not specify the ClientType parameter, all types of clients can be used to connect to cloud desktops.
Valid values:
| windows |
GpuAcceleration | string | No | Specifies whether to enable the image display quality feature for the Graphics cloud desktop. If you have high requirements for desktop performance and user experience, we recommend that you enable this feature. For example, you can enable this feature in professional design scenarios. Valid values:
| off |
UsbSupplyRedirectRule | array<object> | No | The USB redirection rules. | |
object | No | The USB redirection rule. | ||
VendorId | string | No | The ID of the vendor. For more information, see Valid USB Vendor IDs (VIDs). | 04** |
ProductId | string | No | The ID of the service. | 08** |
Description | string | No | The description of the rule. | Test rule |
UsbRedirectType | long | No | The type of USB redirection. Valid values:
| 1 |
DeviceClass | string | No | The class of the device. If you set the | 0Eh |
DeviceSubclass | string | No | The subclass of the device. If you set the | xxh |
UsbRuleType | long | No | The type of the USB redirection rule. Valid values:
| 1 |
DomainResolveRuleType | string | No | The type of the domain name resolution policy. Valid values:
| OFF |
DomainResolveRule | array<object> | No | The details of the domain name resolution policy. | |
object | No | |||
Domain | string | No | The domain name. | *.baidu.com |
Policy | string | No | Specifies whether to allow the policy. Valid values:
| allow |
Description | string | No | The description of the policy. | system policy |
Recording | string | No | Specifies whether to enable screen recording. Valid values:
| OFF |
RecordingStartTime | string | No | The time when screen recording starts. Specify the value in the HH:MM:SS format. The value of this parameter is valid only if you set the Recording parameter to PERIOD. | 08:00:00 |
RecordingEndTime | string | No | The time when the screen recording stops. Specify the value in the HH:MM:SS format. The value of this parameter is valid only if you set the Recording parameter to PERIOD. | 08:59:00 |
RecordingFps | long | No | The frame rate of screen recording. Valid values:
| 2 |
RecordingExpires | long | No | The duration in which the screen recording is valid. Unit: days. | 15 |
CameraRedirect | string | No | Specifies whether to enable the webcam redirection feature. Valid values:
| on |
NetRedirect | string | No | Specifies whether to enable the network redirection feature. Note
This feature is in invitational preview and is not available to the public.
Valid values:
| off |
AppContentProtection | string | No | Specifies whether to enable the anti-screenshot feature. Valid values:
| off |
RecordContent | string | No | Specifies whether to enable the custom screen recording feature. Valid values:
| OFF |
RecordContentExpires | long | No | The duration in which the custom screen recording is valid. Default value: 30. Unit: days. | 30 |
RemoteCoordinate | string | No | The permission to control the keyboard and the mouse during remote assistance. Valid values:
| fullControl |
RecordingDuration | integer | No | The duration from the time when the screen recording starts to the time when the screen recording stops. If you specify the Recording parameter, you must also specify the RecordingDuration parameter. When the specified duration ends, a recording file is generated. | 15 |
Scope | string | No | The effective scope of the policy. Valid values:
| GLOBAL |
ScopeValue | array | No | The effective CIDR block ranges. If you set the Scope parameter to IP, you must specify this parameter. | |
string | No | The effective CIDR block range. | 47.100.XX.XX/24 | |
RecordingAudio | string | No | Specifies whether to record audio data during the screen recording. Valid values:
| on |
InternetCommunicationProtocol | string | No | The protocol that you want to use for network communication. Valid values: -TCP: Only TCP is allowed. -BOTH: Automatic switch between TCP and UDP is allowed. Default value: TCP. | both |
VideoRedirect | string | No | Specifies whether to enable the multimedia redirection feature. Valid values:
| on |
WatermarkTransparencyValue | integer | No | The transparency of the watermark. A larger value specifies that the watermark is less transparent. Valid values: 10 to 100. | 10 |
WatermarkColor | integer | No | The font color of the watermark. Valid values: 0 to 16777215. | 0 |
WatermarkDegree | double | No | The inclination angle of the watermark. Valid values: -10 to -30. | -10 |
WatermarkFontSize | integer | No | The font size of the watermark. Valid values: 10 to 20. | 10 |
WatermarkFontStyle | string | No | The font style of the watermark. Valid values:
| plain |
WatermarkRowAmount | integer | No | The number of watermark rows. This parameter is now invalid. | 5 |
EndUserApplyAdminCoordinate | string | No | Specifies whether to allow end users to seek assistance from the administrator. Valid values: ON OFF | ON |
EndUserGroupCoordinate | string | No | The switch for collaboration between end users. Valid values: ON OFF | ON |
WatermarkSecurity | string | No | The security priority for invisible watermarks. Valid values: on and off. | on |
AdminAccess | string | No | Specifies whether users have the administrator permissions after they connect to cloud desktops. Note
This parameter is in invitational preview and not available to the public.
| deny |
WatermarkAntiCam | string | No | The anti-screen photo feature. Valid values: on and off. | off |
WatermarkPower | string | No | The invisible watermark enhancement feature. Valid values: low, medium, and high. | medium |
RecordingUserNotify | string | No | Specifies whether the feature to send screen recording notifications to clients is enabled. Valid values: on and off. | off |
RecordingUserNotifyMessage | string | No | The notification content sent to clients when screen recording is enabled. By default, you do not need to specify this parameter. | Your desktop is being recorded. |
Response parameters
Examples
Sample success responses
JSON
format
{
"PolicyGroupId": "pg-gx2x1dhsmthe9****",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-15 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
2024-08-05 | The request parameters of the API has changed | View Change Details |
2024-07-19 | The request parameters of the API has changed | View Change Details |
2024-07-01 | The request parameters of the API has changed | View Change Details |
2024-01-26 | The request parameters of the API has changed | View Change Details |
2024-01-05 | The request parameters of the API has changed | View Change Details |
2023-09-20 | The request parameters of the API has changed | View Change Details |
2023-07-31 | The request parameters of the API has changed | View Change Details |
2022-11-04 | The request parameters of the API has changed | View Change Details |
2022-10-08 | The request parameters of the API has changed | View Change Details |
2022-01-11 | The request parameters of the API has changed | View Change Details |
2021-11-30 | The request parameters of the API has changed | View Change Details |