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 that specifies the start point of 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.

AuthorizeAccessPolicyRules Array of AuthorizeAccessPolicyRule

The whitelist of IP addresses that the client can access.

CidrIp String 10.0.XX.XX/8

The IPv4 CIDR block that the client can access.

Description String test

The IPv4 CIDR block that the client can access.

AuthorizeSecurityPolicyRules Array of AuthorizeSecurityPolicyRule

The information about the security group rules.

CidrIp String 10.0.XX.XX/8

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

Description String test

The description of the security group rule.

IpProtocol String tcp

The protocol type of the security group rule. The valid values include:

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

The authorization policy of the security group rule. The valid values include:

  • accept: indicates the Allow policy that allows all access requests.
  • drop: indicates the Deny policy that denies all access requests.
PortRange String 22/22

The port range of the security group rule.

Priority String 1

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

Type String inflow

The direction of the security group rule. The valid values include:

  • inflow: inbound
  • outflow: outbound
ClientTypes Array of ClientType

The types of the clients that are allowed to log on to a cloud desktop.

ClientType String windows

The type of the client. The valid values include:

  • windows: the Windows client
  • linux: the Alibaba Cloud device
  • macos: the macOS client
  • ios: the iOS client
  • android: the Android client
  • html5: the web client
Status String ON

Indicates whether a specific type of client is allowed to log on to a cloud desktop. The valid values include:

  • ON: allowed
  • OFF: denied
Clipboard String readwrite

The permissions on clipboards. The valid values include:

  • read: indicates one-way transfer.
  • readwrite: indicates two-way transfer.
  • off: indicates that the two-way transfer is disabled.
DomainList String [black:],example.com

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

  • [black:],example1.com,example2.com: the domain name blacklist. The cloud desktop cannot access the domain names that are specified in the blacklist.
  • [white:],example1.com,example2.com: the domain name whitelist. The cloud desktop can access only the domain names that are specified in the whitelist.
EdsCount Integer 1

The number of cloud desktops that are associated with the policy.

This parameter is returned only for a custom policy.

Html5Access String off

Indicates whether the access for HTML5 clients is allowed. The valid values include:

  • on: allowed
  • off: denied

Default value: off.

Html5FileTransfer String off

The file transfer policy for HTML5 clients. The valid values include:

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

LocalDrive String readwrite

The permissions on local disk mapping. The valid values include:

  • read: the read-only permissions
  • readwrite: the read and write permissions
  • off: no permissions
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. The valid values include:

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

The status of the policy. The valid values include:

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

Indicates whether user preemption is allowed. Default value: off. Cloud desktops do not allow user preemption.

PreemptLoginUsers List Alice

The users that are allowed to preemptively log on to a cloud desktop.

PrinterRedirection String on

Indicates whether printer redirection is enabled. The valid values include:

  • off: disabled
  • on: enabled
UsbRedirect String on

Indicates whether USB redirection is enabled. The valid values include:

  • on: enabled
  • off: disabled
VisualQuality String medium

The quality of the displayed image. The valid values include:

  • low
  • medium
  • high
  • lossless

Default value: medium.

Watermark String on

Indicates whether watermarking is enabled. The valid values include:

  • on: enabled
  • off: disabled
WatermarkCustomText String test

This parameter is unavailable.

WatermarkTransparency String LIGHT

The transparency of the watermark. The valid values include:

  • LIGHT
  • MIDDLE
  • DARK
WatermarkType String EndUserId

The type of the watermark. The valid values include:

  • EndUserId: the username
  • HostName: the last 15 characters of the cloud desktop ID
  • HostName,EndUserId: the username and the last 15 characters of the cloud desktop ID
  • EndUserId,HostName: the username and the last 15 characters of the cloud desktop ID
NextToken String caeba0bbb2be03f84eb48b699f0a****

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

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

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>
      <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6kb60RyIe8hZIdhSybWz5t4</NextToken>
      <RequestId>2CB27899-306D-56E9-A8F1-AD83D9FEDF3B</RequestId>
      <DescribePolicyGroups>
            <PolicyGroupId>pg-8whrmp8dewbdv****</PolicyGroupId>
            <PrinterRedirection>on</PrinterRedirection>
            <Name>sg-new-02</Name>
            <PolicyGroupType>CUSTOM</PolicyGroupType>
            <LocalDrive>off</LocalDrive>
            <PolicyStatus>AVAILABLE</PolicyStatus>
            <UsbRedirect>off</UsbRedirect>
            <ClientTypes>
                  <Status>ON</Status>
                  <ClientType>windows</ClientType>
            </ClientTypes>
            <ClientTypes>
                  <Status>ON</Status>
                  <ClientType>linux</ClientType>
            </ClientTypes>
            <ClientTypes>
                  <Status>ON</Status>
                  <ClientType>macos</ClientType>
            </ClientTypes>
            <ClientTypes>
                  <Status>OFF</Status>
                  <ClientType>ios</ClientType>
            </ClientTypes>
            <ClientTypes>
                  <Status>OFF</Status>
                  <ClientType>android</ClientType>
            </ClientTypes>
            <ClientTypes>
                  <Status>ON</Status>
                  <ClientType>html5</ClientType>
            </ClientTypes>
            <PreemptLogin>off</PreemptLogin>
            <Html5FileTransfer>off</Html5FileTransfer>
            <EdsCount>1</EdsCount>
            <Clipboard>off</Clipboard>
            <VisualQuality>medium</VisualQuality>
            <Html5Access>on</Html5Access>
            <Watermark>off</Watermark>
      </DescribePolicyGroups>
</DescribePolicyGroupsResponse>

JSON format

{
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kb60RyIe8hZIdhSybWz5t4",
    "RequestId": "2CB27899-306D-56E9-A8F1-AD83D9FEDF3B",
    "DescribePolicyGroups": [
        {
            "PolicyGroupId": "pg-8whrmp8dewbdv****",
            "PrinterRedirection": "on",
            "Name": "sg-new-02",
            "PolicyGroupType": "CUSTOM",
            "LocalDrive": "off",
            "PreemptLoginUsers": [],
            "PolicyStatus": "AVAILABLE",
            "UsbRedirect": "off",
            "ClientTypes": [
                {
                    "Status": "ON",
                    "ClientType": "windows"
                },
                {
                    "Status": "ON",
                    "ClientType": "linux"
                },
                {
                    "Status": "ON",
                    "ClientType": "macos"
                },
                {
                    "Status": "OFF",
                    "ClientType": "ios"
                },
                {
                    "Status": "OFF",
                    "ClientType": "android"
                },
                {
                    "Status": "ON",
                    "ClientType": "html5"
                }
            ],
            "PreemptLogin": "off",
            "Html5FileTransfer": "off",
            "EdsCount": 1,
            "Clipboard": "off",
            "VisualQuality": "medium",
            "Html5Access": "on",
            "Watermark": "off"
        }
    ]
}