调用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

策略的详细信息。

AuthorizeSecurityPolicyRules Array of AuthorizeSecurityPolicyRule

网络管控规则信息。

CidrIp String 10.0.0.0/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:出方向
Clipboard String readwrite

剪切板权限。可能值:

  • read:只读
  • readwrite:读写
  • off:关闭
EdsCount Integer 1

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

仅自定义策略支持返回。

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 on

桌面抢占策略。可能值:

  • on:允许抢占
  • off:不允许抢占
PreemptLoginUsers List Alice

允许抢占桌面的用户。

UsbRedirect String on

USB重定向。可能值:

  • on:开启
  • off:关闭
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 caeba0bbb2be03f84eb48b699f0a4883

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

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

请求ID。

示例

请求示例

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

正常返回示例

XML格式

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

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

错误码

访问错误中心查看更多错误码。