调用DescribePolicyGroups查询策略的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePolicyGroups

系统规定参数。取值:DescribePolicyGroups。

RegionId String cn-hangzhou

地域ID。

MaxResults Integer 10

分页查询时每页行数。

最大值:100

默认值:10

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

PolicyGroupId.N RepeatList system-all-enabled-policy

策略ID。可设置一个或多个。

返回数据

名称 类型 示例值 描述
DescribePolicyGroups Array of DescribePolicyGroup

策略的详细信息。

AuthorizeAccessPolicyRules Array of AuthorizeAccessPolicyRule

客户端访问IP白名单信息。

CidrIp String 10.0.XX.XX/8

客户端访问IP地址段。格式为CIDR格式的IPv4地址段。

Description String test

客户端访问IP地址段。格式为CIDR格式的IPv4地址段。

AuthorizeSecurityPolicyRules Array of AuthorizeSecurityPolicyRule

安全组管控规则信息。

CidrIp String 10.0.XX.XX/8

安全组管控规则的对象,CIDR格式的IPv4地址段。

Description String test

安全组管控规则的描述信息。

IpProtocol String tcp

安全组管控规则的协议类型。可能值:

  • tcp:TCP协议
  • udp:UDP协议
  • icmp:ICMP(IPv4)协议
  • gre:GRE协议
  • all:支持所有协议
Policy String accept

安全组管控规则的授权策略。可能值:

  • accept:允许策略,接收所有访问请求。
  • drop:拒绝策略,拒绝所有访问请求。
PortRange String 22/22

安全组管控规则的端口范围。

Priority String 1

安全组管控规则的优先级,数字越小,代表优先级越高。

Type String inflow

安全组管控规则的规则方向。可能值:

  • inflow:入方向
  • outflow:出方向
ClientTypes Array of ClientType

登录方式管控。

ClientType String windows

客户端类型。可能值:

  • windows:Windows客户端。
  • linux:阿里云云终端。
  • macos:macOS客户端。
  • ios:iOS客户端。
  • android:Android客户端。
  • html5:Web客户端。
Status String ON

是否允许某一类型的客户端登录云桌面。可能值:

  • ON:允许
  • OFF:不允许
Clipboard String readwrite

剪切板权限。可能值:

  • read:单向允许
  • readwrite:双向允许
  • off:双向禁止
DomainList String [black:],example.com

域名黑白名单,域名支持*通配符,多个域名之间以英文半角逗号隔开。可能值:

  • [black:],example1.com,example2.com:域名黑名单,不允许云桌面访问黑名单中的域名
  • [white:],example1.com,example2.com:域名白名单,只允许云桌面访问白名单中的域名
EdsCount Integer 1

关联了该策略的云桌面数量。

仅自定义策略支持返回。

Html5Access String off

HTML5客户端访问策略。可能值:

  • on:允许
  • off:禁止

默认值:off

Html5FileTransfer String off

HTML5客户端文件传输策略。可能值:

  • off:关闭
  • upload:允许上传
  • download:允许下载
  • all:允许上传下载

默认值:off

LocalDrive String readwrite

本地磁盘映射权限。可能值:

  • read:只读
  • readwrite:读写
  • off:关闭
Name String testPolicyGroupName

策略名称。

PolicyGroupId String system-all-enabled-policy

策略ID。

PolicyGroupType String SYSTEM

策略类型。可能值:

  • SYSTEM:系统策略
  • CUSTOM:自定义策略
PolicyStatus String AVAILABLE

策略状态。可能值:

  • CREATING:创建中
  • AVAILABLE:可用
PreemptLogin String off

桌面抢占策略。目前均为off,即禁止抢占。

PreemptLoginUsers List Alice

允许抢占桌面的用户。

PrinterRedirection String on

打印机重定向策略。可能值:

  • off:关闭
  • on:打开
UsbRedirect String on

USB重定向。可能值:

  • on:开启
  • off:关闭
VisualQuality String medium

图像显示质量策略,可能值:

  • low:流畅
  • medium:自适应
  • high:高清
  • lossless:无损

默认值:medium

Watermark String on

水印。可能值:

  • on:开启
  • off:关闭
WatermarkCustomText String test

该参数暂未开放使用。

WatermarkTransparency String LIGHT

水印显示的深浅程度。可能值:

  • LIGHT:较浅
  • MIDDLE:中等
  • DARK:较深
WatermarkType String EndUserId

水印类型。可能值:

  • EndUserId:用户名。
  • HostName:云桌面ID后15位。
  • HostName,EndUserId:用户名和云桌面ID后15位。
  • EndUserId,HostName:用户名和云桌面ID后15位。
NextToken String caeba0bbb2be03f84eb48b699f0a****

下一个查询开始的Token,NextToken为空表示没有下一个。

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

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribePolicyGroups
&MaxResults=10
&PolicyGroupId.1=system-all-enabled-policy
&<公共请求参数>

正常返回示例

XML格式

<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格式

{
    "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"
        }
    ]
}