Queries the details of policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribePolicyGroups

The operation that you want to perform. Set the value to DescribePolicyGroups.

RegionId String Yes cn-hangzhou

The ID of the region.

MaxResults Integer No 10

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query.

PolicyGroupId.N RepeatList No system-all-enabled-policy

The ID of policy N. You can specify one or more policy IDs.

Response parameters

Parameter Type Example Description
DescribePolicyGroups Array of DescribePolicyGroup

Details of the policies.

AuthorizeSecurityPolicyRules Array of AuthorizeSecurityPolicyRule

Details of the network control rules.

CidrIp String 10.0.0.0/8

The object to which the network control rule applies. IPv4 CIDR blocks are returned.

Description String test

The description of the network control rule.

IpProtocol String tcp

The protocol type of the network control rule. Valid values:

  • tcp: TCP
  • udp: UDP
  • icmp: ICMP (IPv4)
  • gre: GRE
  • all: All protocols are supported.
Policy String accept

The authorization policy of the network control rule. Valid values:

  • accept: the Allow policy, which indicates that all access requests are allowed.
  • drop: the Deny policy, which indicates that all access requests are denied.
PortRange String 22/22

The port range of the network control rule.

Priority String 1

The priority of the network control rule. A smaller value indicates a higher priority.

Type String inflow

The rule direction of the network control rule. Valid values:

  • inflow: inbound
  • outflow: outbound
Clipboard String readwrite

The permission on clipboards. Valid values:

  • read: read-only
  • readwrite: read and write
  • off: disabled
EdsCount Integer 1

The number of cloud desktops associated with the policy.

This parameter is returned only for custom policies.

LocalDrive String readwrite

The permission on local disk mapping. Valid values:

  • read: read-only
  • readwrite: read and write
  • off: disabled
Name String testPolicyGroupName

The name of the policy.

PolicyGroupId String system-all-enabled-policy

The ID of the policy.

PolicyGroupType String SYSTEM

The type of the policy. Valid values:

  • SYSTEM: system policy
  • CUSTOM: custom policy
PolicyStatus String AVAILABLE

The status of the policy. Valid values:

  • CREATING: The policy is being created.
  • AVAILABLE: The policy is available.
PreemptLogin String on

Indicates whether to allow user preemption. Valid values:

  • on: allows user preemption.
  • off: disallows user preemption.
PreemptLoginUsers List Alice

The list of users who are allowed to preemptively log on to a cloud desktop.

UsbRedirect String on

Indicates whether USB redirection is enabled. Valid values:

  • on: enabled
  • off: disabled
Watermark String on

Indicates whether watermarking is enabled. Valid values:

  • on: enabled
  • off: disabled
WatermarkCustomText String test

This parameter is unavailable.

WatermarkTransparency String LIGHT

The transparency of the watermark. Valid values:

  • LIGHT
  • MIDDLE
  • DARK
WatermarkType String EndUserId

The type of the watermark. Valid values:

  • EndUserId: username
  • HostName: the rightmost 15 characters of the cloud desktop ID
  • HostName,EndUserId: username and the rightmost 15 characters of the cloud desktop ID
  • EndUserId,HostName: username and the rightmost 15 characters of the cloud desktop ID
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. If this parameter is empty, all results are returned.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribePolicyGroups
&MaxResults=10
&PolicyGroupId.1=system-all-enabled-policy
&<Common request parameters>

Sample success responses

XML format

<DescribePolicyGroupsResponse>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <DescribePolicyGroups>
            <PolicyGroupType>SYSTEM</PolicyGroupType>
            <WatermarkType>EndUserId</WatermarkType>
            <LocalDrive>readwrite</LocalDrive>
            <PolicyGroupId>system-all-enabled-policy</PolicyGroupId>
            <PolicyStatus>AVAILABLE</PolicyStatus>
            <UsbRedirect>on</UsbRedirect>
            <WatermarkCustomText>test</WatermarkCustomText>
            <PreemptLogin>on</PreemptLogin>
            <WatermarkTransparency>LIGHT</WatermarkTransparency>
            <EdsCount>1</EdsCount>
            <Clipboard>readwrite</Clipboard>
            <Watermark>on</Watermark>
            <Name>testPolicyGroupName</Name>
            <AuthorizeSecurityPolicyRules>
                  <Policy>accept</Policy>
                  <CidrIp>10.0.0.0/8</CidrIp>
                  <PortRange>22/22</PortRange>
                  <Type>inflow</Type>
                  <Description>test</Description>
                  <Priority>1</Priority>
                  <IpProtocol>tcp</IpProtocol>
            </AuthorizeSecurityPolicyRules>
            <PreemptLoginUsers>Alice</PreemptLoginUsers>
      </DescribePolicyGroups>
</DescribePolicyGroupsResponse>

JSON format

{
	"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
	"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
	"DescribePolicyGroups": [{
		"PolicyGroupType": "SYSTEM",
		"WatermarkType": "EndUserId",
		"LocalDrive": "readwrite",
		"PolicyGroupId": "system-all-enabled-policy",
		"PolicyStatus": "AVAILABLE",
		"UsbRedirect": "on",
		"WatermarkCustomText": "test",
		"PreemptLogin": "on",
		"WatermarkTransparency": "LIGHT",
		"EdsCount": "1",
		"Clipboard": "readwrite",
		"Watermark": "on",
		"Name": "testPolicyGroupName",
		"AuthorizeSecurityPolicyRules": [{
			"Policy": "accept",
			"CidrIp": "10.0.0.0/8",
			"PortRange": "22/22",
			"Type": "inflow",
			"Description": "test",
			"Priority": "1",
			"IpProtocol": "tcp"
		}],
		"PreemptLoginUsers": "Alice"
	}]
}