首页 无影云桌面 API参考(云桌面管控) API目录 策略 DescribePolicyGroups - 查询策略详细信息

DescribePolicyGroups - 查询策略详细信息

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecd:DescribePolicyGroupsLIST
  • ECD
    acs:ecd:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。可以调用DescribeRegions获取无影云桌面支持的地域列表。

cn-hangzhou
MaxResultsinteger

分页查询时每页行数。

  • 最大值:100
  • 默认值:10
10
NextTokenstring

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdarray

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

string

策略ID。

system-all-enabled-policy
Scopestring

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

请求ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
DescribePolicyGroupsarray

策略的详细信息。

object

策略的详细信息。

PolicyStatusstring

策略状态。

AVAILABLE
枚举值:
- AVAILABLE: 可用
- CREATING: 创建中
Html5Accessstring

HTML5客户端访问策略。

off
枚举值:
- off: 禁止 [默认值]
- on: 允许
WatermarkTypestring

水印类型。

EndUserId
枚举值:
- HostName,EndUserId: 用户名和云桌面ID后15位
- EndUserId: 用户名
- EndUserId,HostName: 用户名和云桌面ID后15位
- HostName: 云桌面ID后15位
PreemptLoginstring

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

off
WatermarkCustomTextstring

该参数暂未开放使用。

test
Clipboardstring

剪贴板权限。

readwrite
枚举值:
- read: 单向允许
- readwrite: 双向允许
- off: 双向禁止
DomainListstring

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

  • [black:],example.com,example.org:域名黑名单,不允许云桌面访问黑名单中的域名

  • [white:],example.com,example.org:域名白名单,只允许云桌面访问白名单中的域名

[black:],example.com
PolicyGroupIdstring

策略ID。

pg-gx2x1dhsmthe9****
PrinterRedirectionstring

打印机重定向策略。

on
枚举值:
- off: 关闭
- on: 打开
WatermarkTransparencystring

水印显示的深浅程度。

LIGHT
枚举值:
- LIGHT: 较浅
- DARK: 较深
- MIDDLE: 中等
Html5FileTransferstring

HTML5客户端文件传输策略。

off
枚举值:
- all: 允许上传下载
- download: 允许下载
- upload: 允许上传
- off: 关闭 [默认值]
UsbRedirectstring

USB重定向。

on
枚举值:
- off: 关闭
- on: 开启
PolicyGroupTypestring

策略类型。

SYSTEM
枚举值:
- SYSTEM: 系统策略
- CUSTOM: 自定义策略
Watermarkstring

水印。

on
枚举值:
- off: 关闭
- on: 开启
VisualQualitystring

图像显示质量策略。

medium
枚举值:
- high: 高清
- low: 流畅
- medium: 自适应 [默认值]
- lossless: 无损
EdsCountinteger

关联了该策略的云桌面数量。
仅自定义策略支持返回。

1
Namestring

策略名称。

testPolicyGroupName
LocalDrivestring

本地磁盘映射权限。

readwrite
枚举值:
- read: 只读
- readwrite: 读写
- off: 关闭
AuthorizeSecurityPolicyRulesarray

安全组管控规则信息数组。

object

安全组管控规则信息对象。

Typestring

安全组管控规则的规则方向。

inflow
枚举值:
- outflow: 出方向
- inflow: 入方向
Policystring

安全组管控规则的授权策略。

accept
枚举值:
- drop: 拒绝策略,拒绝所有访问请求。
- accept: 允许策略,接收所有访问请求。
Descriptionstring

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

test
PortRangestring

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

22/22
IpProtocolstring

安全组管控规则的协议类型。

tcp
枚举值:
- tcp: TCP协议
- udp: UDP协议
- all: 支持所有协议
- gre: GRE协议
- icmp: ICMP(IPv4)协议
Prioritystring

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

1
CidrIpstring

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

47.100.XX.XX/16
AuthorizeAccessPolicyRulesarray

客户端访问IP白名单数组。

object

客户端访问IP白名单对象。

Descriptionstring

客户端访问IP地址段备注信息。

test
CidrIpstring

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

47.100.XX.XX/16
ClientTypesarray

登录方式管控数组。

object

登录方式管控对象。

Statusstring

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

ON
枚举值:
- OFF: 不允许
- ON: 允许
ClientTypestring

客户端类型。

windows
枚举值:
- html5: Web客户端
- linux: 阿里云云终端
- android: Android客户端
- windows: Windows客户端
- ios: iOS客户端
- macos: macOS客户端
PreemptLoginUsersarray

可抢占桌面的一组用户的用户名。

string

可抢占桌面的用户的用户名。

Alice
GpuAccelerationstring

是否为图形型规格云桌面开启画质策略。对桌面性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。

off
枚举值:
- off: 关闭
- on: 开启
UsbSupplyRedirectRulearray

USB重定向规则。

object

USB重定向规则。

VendorIdstring

生产厂商ID。参见Valid USB Vendor IDs (VIDs)

04**
ProductIdstring

产品ID。

08**
Descriptionstring

规则描述。

测试规则
UsbRedirectTypelong

USB重定向类型。

1
枚举值:
- 1: 允许
- 2: 拒绝
DeviceClassstring

设备类别,当usbRuleType为1的时候需要填写。参见Defined Class Codes

0Eh
DeviceSubclassstring

设备子类别,当usbRuleType为1的时候需要填写。参见Defined Class Codes

xxh
UsbRuleTypelong

USB重定向规则类型。

1
枚举值:
- 1: 设备类别
- 2: 设备厂商
Recordingstring

是否开启录屏。

OFF
枚举值:
- ALLTIME: 全程录屏,从登录桌面开始到退出桌面。
- PERIOD: 间隔录屏,需设置录屏开始和结束时间。
- OFF: 不开启录屏。
RecordingStartTimestring

录屏开始时间,取值:HH:MM:SS。只有Recording取值是PERIOD时,该返回值有实际意义。

08:00:00
RecordingEndTimestring

录屏结束时间,取值:HH:MM:SS。只有Recording取值是PERIOD时,该返回值有实际意义。

08:59:00
RecordingFpslong

录屏帧数。取值范围:

  • 2
  • 5
  • 10
  • 15
5
RecordingExpireslong

录屏审计过期时间。取值范围 15-180天。

15
CameraRedirectstring

是否开启本地摄像头重定向。

on
枚举值:
- off: 关闭
- on: 开启 [默认值]
NetRedirectstring

网络重定向,取值范围: on: 开启 off: 关闭 默认值是 off

off
AppContentProtectionstring

是否开启防截屏功能。取值范围:

on:开启。 off:关闭。 默认值:off。

off
RecordContentstring

是否开启自定义录屏。取值范围:

on:开启。 off:关闭。 默认值:off。

off
RecordContentExpireslong

自定义录屏的文件过期时间,默认30天。

30
RemoteCoordinatestring

远程协助键鼠控制权限,取值范围: fullControl:完全控制。 optionalControl:默认关闭,可以点击申请键鼠操作权限打开。 disableControl:不控制。

fullControl
RecordingDurationinteger

与Recording录屏选项配合使用,录屏指定时长后生成录屏文件。

10
Scopestring

策略的生效范围。取值范围:

  • GLOBAL:全局生效。
  • IP:根据IP生效。
GLOBAL
ScopeValuearray

Scope取值为IP的时候填写。

string

生效的cidr block。

47.100.XX.XX/24
RecordingAudiostring

录制桌面声音选项,取值范围: on:音画同期录制。 off:仅录制画面不录制声音。

on
枚举值:
- off: 关闭声音录制[默认选项]
- on: 开启声音录制
InternetCommunicationProtocolstring

网络通信协议。取值范围: -TCP:只允许使用TCP。 -BOTH:允许自动在TCP和UDP之间切换。 默认值:TCP。

BOTH

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "DescribePolicyGroups": [
    {
      "PolicyStatus": "AVAILABLE",
      "Html5Access": "off",
      "WatermarkType": "EndUserId",
      "PreemptLogin": "off",
      "WatermarkCustomText": "test",
      "Clipboard": "readwrite",
      "DomainList": "[black:],example.com",
      "PolicyGroupId": "pg-gx2x1dhsmthe9****",
      "PrinterRedirection": "on",
      "WatermarkTransparency": "LIGHT",
      "Html5FileTransfer": "off",
      "UsbRedirect": "on",
      "PolicyGroupType": "SYSTEM",
      "Watermark": "on",
      "VisualQuality": "medium",
      "EdsCount": 1,
      "Name": "testPolicyGroupName",
      "LocalDrive": "readwrite",
      "AuthorizeSecurityPolicyRules": [
        {
          "Type": "inflow",
          "Policy": "accept",
          "Description": "test",
          "PortRange": "22/22",
          "IpProtocol": "tcp",
          "Priority": "1",
          "CidrIp": "47.100.XX.XX/16"
        }
      ],
      "AuthorizeAccessPolicyRules": [
        {
          "Description": "test",
          "CidrIp": "47.100.XX.XX/16"
        }
      ],
      "ClientTypes": [
        {
          "Status": "ON",
          "ClientType": "windows"
        }
      ],
      "PreemptLoginUsers": [
        "Alice"
      ],
      "GpuAcceleration": "off",
      "UsbSupplyRedirectRule": [
        {
          "VendorId": "04**",
          "ProductId": "08**",
          "Description": "测试规则",
          "UsbRedirectType": 1,
          "DeviceClass": "0Eh",
          "DeviceSubclass": "xxh",
          "UsbRuleType": 1
        }
      ],
      "Recording": "OFF",
      "RecordingStartTime": "08:00:00",
      "RecordingEndTime": "08:59:00",
      "RecordingFps": 5,
      "RecordingExpires": 15,
      "CameraRedirect": "on",
      "NetRedirect": "off",
      "AppContentProtection": "off",
      "RecordContent": "off",
      "RecordContentExpires": 30,
      "RemoteCoordinate": "fullControl",
      "RecordingDuration": 10,
      "Scope": "GLOBAL",
      "ScopeValue": [
        "47.100.XX.XX/24"
      ],
      "RecordingAudio": "on",
      "InternetCommunicationProtocol": "BOTH"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-11-04OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-10-08OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-01-11OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-11-30OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云桌面 相关技术圈