Modifies a policy.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region where the cloud desktop resides. | cn-hangzhou |
PolicyGroupId | string | Yes | The ID of the policy. | pg-gx2x1dhsmthe9**** |
Name | string | No | The name of the policy. | testPolicyGroupName |
Clipboard | string | No | The permissions on clipboards. 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 | Specify whether to enable the policy of image display quality. Valid values:
Default value: off. | low |
Html5Access | string | No | Specifies whether to allow the access from HTM5 clients to a cloud desktop. Valid values:
Default value: off. Note
We recommend that you use the ClientType-related parameters to control the EDS client type for cloud desktop logon.
| off |
Html5FileTransfer | string | No | The file transfer policy for HTML5 clients. Valid values:
Default value: off. | off |
Watermark | string | No | Specifies whether to enable watermarking. Valid values:
| off |
WatermarkType | string | No | The type of the watermark. You can specify multiple watermark types at a time. Separate watermark types with commas (,). Valid values:
| EndUserId |
WatermarkTransparency | string | No | The transparency of the watermark. The valid values include:
| LIGHT |
PreemptLogin | string | No | Specifies whether to allow user preemption. Default value: off. You cannot change the value. | off |
DomainList | string | No | The domain blacklist or whitelist. Wildcard domains are supported. Separate domain names with commas (,). Valid values:
| [black:],example1.com,example2.com |
PrinterRedirection | string | No | Specifies whether to enable printer redirection. Valid values:
| off |
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, multiple end users cannot connect to the same cloud desktop at the same time.
| |
string | No | The name of the user that is allowed to connect to a cloud desktop to which another user is connected. | Alice | |
AuthorizeSecurityPolicyRule | object [] | No | The security group rules. | |
Type | string | No | The direction of security group rule N. Valid values:
| inflow |
Policy | string | No | The authorization policy of security group rule N. Valid values:
| accept |
PortRange | string | No | The port range of security group rule N. The value of the port range is determined by the protocol type specified by the AuthorizeSecurityPolicyRule.N.IpProtocol parameter.
For more information about the common ports of typical applications, see Common ports. | 22/22 |
Description | string | No | The description of security group rule N. | test |
IpProtocol | string | No | The protocol type of security group rule N. Valid values:
| tcp |
Priority | string | No | The priority of security group rule N. A smaller value indicates a higher priority. Valid values: 1 to 60. Default value: 1. | 1 |
CidrIp | string | No | The object to which the security group rule applies. The value is an IPv4 CIDR block. | 10.0.XX.XX/8 |
RevokeSecurityPolicyRule | object [] | No | The security group rules that you want to delete. | |
Type | string | No | The direction of the security group rule that you want to delete. Valid values:
| outflow |
Policy | string | No | The authorization policy of the security group rule that you want to delete. Valid values:
Default value: accept. | accept |
PortRange | string | No | The port range of the security group rule that you want to delete. The value of the port range is determined by the protocol type specified by the IpProtocol parameter.
For more information about the common ports of typical 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 indicates a higher priority. Valid values: 1 to 60. Default value: 1. | 1 |
CidrIp | string | No | The IPv4 CIDR block of the security group rule. | 47.100.XX.XX/16 |
AuthorizeAccessPolicyRule | object [] | No | The client CIDR blocks in the whitelist. | |
Description | string | No | The description of the client IP address whitelist. | test |
CidrIp | string | Yes | The CIDR block that the client can access. | 47.100.XX.XX/16 |
RevokeAccessPolicyRule | object [] | No | The security group rules that you want to delete. | |
Description | string | No | The description of the client IP address whitelist that you want to delete. | test |
CidrIp | string | No | The IPv4 CIDR block that can be accessed from the client. | 47.100.XX.XX/16 |
ClientType | object [] | No | The logon methods. | |
ClientType | string | No | The type of client that you want to use to connect to the cloud desktop. Valid values:
Note
By default, if you do not configure the ClientType-related parameters, all types of clients are allowed to connect to the cloud desktop.
| windows |
Status | string | No | The logon method. This parameter specifies whether a specific type of the client is allowed to connect to the cloud desktop. Valid values:
Note
By default, if you do not configure the ClientType-related parameters, all types of clients are allowed to log on to cloud desktops.
| ON |
GpuAcceleration | string | No | Specifies whether to enable the image display quality feature for the Graphics cloud desktop. If your business requires high desktop performance and optimal user experience, we recommend that you enable this feature. For example, you can enable this policy in professional design scenarios. Valid values:
| off |
UsbSupplyRedirectRule | object [] | No | The USB redirection rules. | |
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 | Specifies whether to allow USB redirection. Valid values:
| 1 |
DeviceClass | string | No | The class of the device. This parameter is required when you set the usbRuleType parameter to 1. For more information, see Defined Class Codes. | 0Eh |
DeviceSubclass | string | No | The subclass of the device. This parameter is required when you set the usbRuleType parameter to 1. For more information, see Defined Class Codes. | xxh |
UsbRuleType | long | No | The type of the USB redirection rule. Valid values:
| 1 |
DomainResolveRuleType | string | No | The DNS rule type. | OFF |
DomainResolveRule | object [] | No | The details of the DNS rule. | |
Domain | string | No | The domain name. | *.igetget.com |
Policy | string | No | Specifies whether to allow the DNS rule. Valid values:
| block |
Description | string | No | The description of the DNS rule. | description policy |
Recording | string | No | Specifies whether to enable screen recording. Valid values:
| OFF |
RecordingStartTime | string | No | The time when the screen recording starts. Specify the value in the HH:MM:SS format. The value is valid only when you set the Recording parameter to PERIOD. | 08:00:00 |
RecordingEndTime | string | No | The time when the screen recording ends. Specify the value in the HH:MM:SS format. The value is valid only when you set the Recording parameter to PERIOD. | 08:59:00 |
RecordingFps | long | No | The frame rate of screen recording. Unit: fps. Valid values:
| 5 |
RecordingExpires | long | No | The period in which the screen recording audit is valid. Valid values: 15 to 180. Unit: days. | 30 |
NetRedirect | string | No | The network redirection feature. Valid values:
Default value: off. | on |
CameraRedirect | string | No | Specifies whether to enable the webcam redirection feature. Valid values:
Default value: on. | on |
AppContentProtection | string | No | Specifies whether to enable the anti-screenshot feature. Valid values:
Default value: off. | on |
RecordContent | string | No | Specifies whether to enable the custom screen recording feature. Valid values:
Default value: off. | OFF |
RecordContentExpires | long | No | The duration in which the custom screen recording is valid. Default value: 30. Unit: days. | 30 |
RemoteCoordinate | string | No | The permissions on the keyboard and mouse to control the cloud desktop during remote assistance. Valid values:
| fullControl |
RecordingDuration | integer | No | This parameter takes effect based on the Recording-related parameters. You can specify a time range for screen recording, and recording files are generated after the specified end time is reached. | 15 |
Scope | string | No | The effective scope of the policy. Valid values:
| GLOBAL |
ScopeValue | array | No | This parameter is required when the Scope parameter is set to IP. | |
string | No | The CIDR block in effect. | 47.100.XX.XX/24 | |
RecordingAudio | string | No | Specifies whether to record the sound that is generated on the cloud desktop during screen recording. Valid values:
| on |
InternetCommunicationProtocol | string | No | The protocol that you want to use for network communication. Valid values:
Default value: TCP. | BOTH |
VideoRedirect | string | No | The multimedia redirection feature. | on |
WatermarkTransparencyValue | integer | No | The transparency of the watermark. A larger value indicates a less transparent watermark. 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. Value values: -10 to -30. | -10 |
WatermarkFontSize | integer | No | The font size of the watermark. Valid values: 10 to 50 | 10 |
WatermarkFontStyle | string | No | The font style of the watermark. Valid values:
| plain |
WatermarkRowAmount | integer | No | The number of watermark rows. This parameter is not in use. | 3 |
EndUserApplyAdminCoordinate | string | No | The user applies for the administrator assistance switch. Value range:
| on |
EndUserGroupCoordinate | string | No | The flow collaboration switch between users. Value range:
| on |
WatermarkSecurity | string | No | The security priority rule for invisible watermarks. Valid values: on and off. | off |
AdminAccess | string | No | Specifies whether the end user has administrator permissions after the end user connects to the cloud desktop. Note
This parameter is in invitational preview and not available to the public.
| deny |
WatermarkAntiCam | string | No | Specifies whether to enable the anti-screen photo feature for invisible watermarks. on and off (default). | off |
WatermarkPower | string | No | The watermark enhancement feature. Valid values: low, medium, and high. | medium |
RecordingUserNotify | string | No | Specifies whether to enable the screen recording notification feature. Valid values: on and off. on and off (default). | off |
RecordingUserNotifyMessage | string | No | The content of the screen recording notification sent to the client. By default, you do not need to specify this parameter. | Your desktop is being recorded. |
Response parameters
Examples
Sample success responses
JSON
format
{
"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-01-26 | The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2024-01-05 | The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2023-09-20 | The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2023-07-31 | The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2022-11-04 | The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2022-10-08 | The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2022-01-11 | The request parameters of the API has changed | see changesets | ||||||||||||
| ||||||||||||||
2021-11-30 | The request parameters of the API has changed | see changesets | ||||||||||||
|