All Products
Search
Document Center

WUYING Workspace:ModifyPolicyGroup

Last Updated:Apr 18, 2024

Modifies a policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the cloud desktop resides.

cn-hangzhou
PolicyGroupIdstringYes

The ID of the policy.

pg-gx2x1dhsmthe9****
NamestringNo

The name of the policy.

testPolicyGroupName
ClipboardstringNo

The permissions on clipboards. Valid values:

  • read: specifies one-way transfer. You can copy data from your computer to cloud desktops, but cannot copy data from cloud desktops to your computer.
  • readwrite: specifies two-way transfer. You can copy data between your computer and cloud desktops.
  • off: specifies that the two-way transfer is disabled. You cannot copy data between your computer and cloud desktops.
off
LocalDrivestringNo

The permissions on local disk mapping. Valid values:

  • read: read-only permissions. Local disks are mapped to cloud desktops. You can only read (copy) local files but cannot modify them.
  • readwrite: read and write permissions. Local disks are mapped to cloud desktops. You can read (copy) and modify local files.
  • off: no permissions. Local disks are not mapped to cloud desktops.
off
UsbRedirectstringNo

Specifies whether to enable USB redirection. Valid values:

  • on: enables USB redirection.
  • off: disables USB redirection.
off
VisualQualitystringNo

Specify whether to enable the policy of image display quality. Valid values:

  • on: enables the policy of image display quality.
  • off: disables the policy of image display quality.

Default value: off.

low
Html5AccessstringNo

Specifies whether to allow the access from HTM5 clients to a cloud desktop. Valid values:

  • on: allows the access.
  • off: denies the access.

Default value: off.

Note We recommend that you use the ClientType-related parameters to control the EDS client type for cloud desktop logon.
off
Html5FileTransferstringNo

The file transfer policy for HTML5 clients. Valid values:

  • off: Files cannot be uploaded from or downloaded to HTML5 clients.
  • upload: Files can be uploaded from HTML5 clients.
  • download: Files can be downloaded to HTML5 clients.
  • all: Files can be uploaded from and downloaded to HTML5 clients.

Default value: off.

off
WatermarkstringNo

Specifies whether to enable watermarking. Valid values:

  • on: enables watermarking.
  • off: disables watermarking.
off
WatermarkTypestringNo

The type of the watermark. You can specify multiple watermark types at a time. Separate watermark types with commas (,). Valid values:

  • EndUserId: the username
  • HostName: the last 15 characters of the cloud desktop ID
EndUserId
WatermarkTransparencystringNo

The transparency of the watermark. The valid values include:

  • LIGHT
  • MIDDLE
  • DARK
LIGHT
PreemptLoginstringNo

Specifies whether to allow user preemption. Default value: off. You cannot change the value.

off
DomainListstringNo

The domain blacklist or whitelist. Wildcard domains are supported. Separate domain names with commas (,). Valid values:

  • [black:],example1.com,example2.com: the domain name blacklist.
  • [white:],example1.com,example2.com: the domain name whitelist.
[black:],example1.com,example2.com
PrinterRedirectionstringNo

Specifies whether to enable printer redirection. Valid values:

  • off: disables printer redirection.
  • on: enables printer redirection.
off
PreemptLoginUserarrayNo

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.
stringNo

The name of the user that is allowed to connect to a cloud desktop to which another user is connected.

Alice
AuthorizeSecurityPolicyRuleobject []No

The security group rules.

TypestringNo

The direction of security group rule N. Valid values:

  • inflow: inbound
  • outflow: outbound
inflow
PolicystringNo

The authorization policy of security group rule N. Valid values:

  • accept: specifies the Allow policy that allows all access requests.
  • drop: specifies the Deny policy that denies all access requests. If no messages of access denied are returned, the requests time out or failed.
accept
PortRangestringNo

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.

  • When the AuthorizeSecurityPolicyRule.N.IpProtocol parameter is set to tcp or udp, the port range is 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.
  • When AuthorizeSecurityPolicyRule.N.IpProtocol is set to icmp, set the value to -1/-1.
  • When AuthorizeSecurityPolicyRule.N.IpProtocol is set to gre, set the value to -1/-1.
  • When AuthorizeSecurityPolicyRule.N.IpProtocol is set to all, set the value to -1/-1.

For more information about the common ports of typical applications, see Common ports.

22/22
DescriptionstringNo

The description of security group rule N.

test
IpProtocolstringNo

The protocol type of security group rule N. Valid values:

  • tcp: TCP
  • udp: UDP
  • icmp: ICMP (IPv4)
  • gre: GRE
  • all: all protocols
tcp
PrioritystringNo

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

Valid values: 1 to 60.

Default value: 1.

1
CidrIpstringNo

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

10.0.XX.XX/8
RevokeSecurityPolicyRuleobject []No

The security group rules that you want to delete.

TypestringNo

The direction of the security group rule that you want to delete. Valid values:

  • inflow: inbound
  • outflow: outbound
outflow
PolicystringNo

The authorization policy of the security group rule that you want to delete. Valid values:

  • accept: allows all access requests.
  • drop: disallows all access requests. If no denied messages are returned, the requests timed out or failed.

Default value: accept.

accept
PortRangestringNo

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.

  • If the IpProtocol parameter is set to TCP or UDP, the port range is 1 to 65535. The start port number and the end port number are separated by a forward slash (/). Example: 1/200.
  • If the IpProtocol parameter is set to ICMP, the port range is -1/-1.
  • If the IpProtocol parameter is set to GRE, the port range is -1/-1.
  • If the IpProtocol parameter is set to ALL, the port range is -1/-1.

For more information about the common ports of typical applications, see Common ports.

22/22
DescriptionstringNo

The description of the security group rule.

test
IpProtocolstringNo

The protocol type of the security group rule. Valid values:

  • TCP
  • UDP
  • ICMP: ICMP (IPv4)
  • GRE
  • ALL
tcp
PrioritystringNo

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

Valid values: 1 to 60.

Default value: 1.

1
CidrIpstringNo

The IPv4 CIDR block of the security group rule.

47.100.XX.XX/16
AuthorizeAccessPolicyRuleobject []No

The client CIDR blocks in the whitelist.

DescriptionstringNo

The description of the client IP address whitelist.

test
CidrIpstringYes

The CIDR block that the client can access.

47.100.XX.XX/16
RevokeAccessPolicyRuleobject []No

The security group rules that you want to delete.

DescriptionstringNo

The description of the client IP address whitelist that you want to delete.

test
CidrIpstringNo

The IPv4 CIDR block that can be accessed from the client.

47.100.XX.XX/16
ClientTypeobject []No

The logon methods.

ClientTypestringNo

The type of client that you want to use to connect to the cloud desktop. Valid values:

  • windows: the Windows client
  • linux: C-Key Series Cloud Computer TC and A Series Cloud Computer TC
  • macos: the macOS client
  • ios: the iOS client
  • android: the Android client
  • html5: the web client
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
StatusstringNo

The logon method. This parameter specifies whether a specific type of the client is allowed to connect to the cloud desktop. Valid values:

  • on: allowed.
  • off: disallowed.
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
GpuAccelerationstringNo

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:

  • on
  • off
off
UsbSupplyRedirectRuleobject []No

The USB redirection rules.

VendorIdstringNo

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

04**
ProductIdstringNo

The ID of the service.

08**
DescriptionstringNo

The description of the rule.

Test rule
UsbRedirectTypelongNo

Specifies whether to allow USB redirection. Valid values:

  • 1: allowed.
  • 2: disallowed.
1
DeviceClassstringNo

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
DeviceSubclassstringNo

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
UsbRuleTypelongNo

The type of the USB redirection rule. Valid values:

  • 1: device class.
  • 2: device vendor.
1
DomainResolveRuleTypestringNo

The DNS rule type.

OFF
DomainResolveRuleobject []No

The details of the DNS rule.

DomainstringNo

The domain name.

*.igetget.com
PolicystringNo

Specifies whether to allow the DNS rule.

Valid values:

  • allow

  • block

block
DescriptionstringNo

The description of the DNS rule.

description policy
RecordingstringNo

Specifies whether to enable screen recording. Valid values:

  • OFF: disabled.
  • ALLTIME: All operations that are performed by an end user on the cloud desktop are recorded. The recording immediately starts when the end user connects to the cloud desktop and ends after the end user disconnects from the cloud desktop.
  • PERIOD: The operations that are performed by an end user on the cloud desktop during a specific period of time are recorded. You must specify the start time and the end time of the recording.
OFF
RecordingStartTimestringNo

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
RecordingEndTimestringNo

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
RecordingFpslongNo

The frame rate of screen recording. Unit: fps. Valid values:

  • 2
  • 5
  • 10
  • 15
5
RecordingExpireslongNo

The period in which the screen recording audit is valid. Valid values: 15 to 180. Unit: days.

30
NetRedirectstringNo

The network redirection feature. Valid values:

  • on
  • off

Default value: off.

on
CameraRedirectstringNo

Specifies whether to enable the webcam redirection feature. Valid values:

  • on
  • off

Default value: on.

on
AppContentProtectionstringNo

Specifies whether to enable the anti-screenshot feature. Valid values:

  • on
  • off

Default value: off.

on
RecordContentstringNo

Specifies whether to enable the custom screen recording feature. Valid values:

  • on
  • off

Default value: off.

OFF
RecordContentExpireslongNo

The duration in which the custom screen recording is valid. Default value: 30. Unit: days.

30
RemoteCoordinatestringNo

The permissions on the keyboard and mouse to control the cloud desktop during remote assistance. Valid values:

  • fullControl: The keyboard and mouse can be fully controlled.
  • optionalControl: By default, this feature is disabled. You can apply for permissions to enable the feature.
  • disableControl: The keyboard and mouse cannot be controlled.
fullControl
RecordingDurationintegerNo

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
ScopestringNo

The effective scope of the policy. Valid values:

  • GLOBAL: takes effect globally.
  • IP: takes effect based on the IP address.
GLOBAL
ScopeValuearrayNo

This parameter is required when the Scope parameter is set to IP.

stringNo

The CIDR block in effect.

47.100.XX.XX/24
RecordingAudiostringNo

Specifies whether to record the sound that is generated on the cloud desktop during screen recording. Valid values:

  • on
  • off
on
InternetCommunicationProtocolstringNo

The protocol that you want to use for network communication. Valid values:

  • TCP: Only the TCP protocol is used.
  • BOTH: allows automatic switchover between the TCP protocol and the UDP protocol.

Default value: TCP.

BOTH
VideoRedirectstringNo

The multimedia redirection feature.

on
WatermarkTransparencyValueintegerNo

The transparency of the watermark. A larger value indicates a less transparent watermark. Valid values: 10 to 100.

10
WatermarkColorintegerNo

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

0
WatermarkDegreedoubleNo

The inclination angle of the watermark. Value values: -10 to -30.

-10
WatermarkFontSizeintegerNo

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

10
WatermarkFontStylestringNo

The font style of the watermark. Valid values:

  • plain
  • bold
plain
WatermarkRowAmountintegerNo

The number of watermark rows. This parameter is not in use.

3
EndUserApplyAdminCoordinatestringNo

The user applies for the administrator assistance switch. Value range:

  • on
  • off
on
EndUserGroupCoordinatestringNo

The flow collaboration switch between users. Value range:

  • on
  • off
on
WatermarkSecuritystringNo

The security priority rule for invisible watermarks. Valid values: on and off.

off
AdminAccessstringNo

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
WatermarkAntiCamstringNo

Specifies whether to enable the anti-screen photo feature for invisible watermarks. on and off (default).

off
WatermarkPowerstringNo

The watermark enhancement feature. Valid values: low, medium, and high.

medium
RecordingUserNotifystringNo

Specifies whether to enable the screen recording notification feature. Valid values: on and off. on and off (default).

off
RecordingUserNotifyMessagestringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-26The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: WatermarkAntiCam
    Added Input Parameters: WatermarkPower
    Added Input Parameters: RecordingUserNotify
    Added Input Parameters: RecordingUserNotifyMessage
2024-01-05The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AdminAccess
2023-09-20The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: WatermarkSecurity
2023-07-31The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DomainResolveRuleType
    Added Input Parameters: DomainResolveRule
2022-11-04The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: RecordingAudio
2022-10-08The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: RecordingDuration
2022-01-11The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Recording
    Added Input Parameters: RecordingStartTime
    Added Input Parameters: RecordingEndTime
    Added Input Parameters: RecordingFps
    Added Input Parameters: CameraRedirect
2021-11-30The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: GpuAcceleration