文档

DescribePolicyGroups - 查询策略详细信息

更新时间:

查询策略的详细信息。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
MaxResultsinteger

分页查询时每页行数。

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

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

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdarray

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

string

策略 ID。

system-all-enabled-policy
Scopestring

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

  • GLOBAL:全局生效。
  • IP:根据 IP 生效。
  • ALL: 全部策略。

默认为 GLOBAL。

ALL

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
DescribePolicyGroupsobject []

策略的详细信息。

PolicyStatusstring

策略状态。

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

HTML5 客户端访问策略。

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

水印类型。

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

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

off
WatermarkCustomTextstring

该参数暂未开放使用。

test
Clipboardstring

剪贴板权限。

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

访问域名权限管控。域名支持*通配符,多个域名之间以英文半角逗号隔开。取值范围:

  • off:关闭。

  • on:开启。

off
PolicyGroupIdstring

策略 ID。

pg-gx2x1dhsmthe9****
PrinterRedirectionstring

打印机重定向策略。

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

水印显示的深浅程度。

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

HTML5 客户端文件传输策略。

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

USB 重定向。

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

策略类型。

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

水印。

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

图像显示质量策略。

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

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

1
Namestring

策略名称。

testPolicyGroupName
LocalDrivestring

本地磁盘映射权限。

枚举值:
  • read只读
  • readwrite读写
  • off关闭
readwrite
AuthorizeSecurityPolicyRulesobject []

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

Typestring

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

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

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

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

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

test
PortRangestring

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

22/22
IpProtocolstring

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

枚举值:
  • tcpTCP协议
  • udpUDP协议
  • all支持所有协议
  • greGRE协议
  • icmpICMP(IPv4)协议
tcp
Prioritystring

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

1
CidrIpstring

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

47.100.XX.XX/16
AuthorizeAccessPolicyRulesobject []

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

Descriptionstring

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

test
CidrIpstring

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

47.100.XX.XX/16
ClientTypesobject []

登录方式管控数组。

Statusstring

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

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

客户端类型。

枚举值:
  • html5Web客户端
  • linux阿里云云终端
  • androidAndroid客户端
  • windowsWindows客户端
  • iosiOS客户端
  • macosmacOS客户端
windows
PreemptLoginUsersarray

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

string

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

Alice
GpuAccelerationstring

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

枚举值:
  • off关闭
  • on开启
off
UsbSupplyRedirectRuleobject []

USB 重定向规则。

VendorIdstring

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

04**
ProductIdstring

产品 ID。

08**
Descriptionstring

规则描述。

测试规则
UsbRedirectTypelong

USB 重定向类型。

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

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

0Eh
DeviceSubclassstring

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

xxh
UsbRuleTypelong

USB 重定向规则类型。

枚举值:
  • 1设备类别
  • 2设备厂商
1
DomainResolveRuleTypestring

域名解析策略开关。

枚举值:
  • off关闭
  • on开启
on
DomainResolveRuleobject []

域名解析策略列表。

Domainstring

域名。

*.com
Policystring

解析策略,取值范围。

  • allow: 允许。
  • block: 拒绝。
allow
Descriptionstring

策略描述。

测试规则
NetRedirectRuleobject []

网络重定向策略列表。

说明 该功能处于定向邀测中,暂不对外开放。
Domainstring

策略内容。

*.com
RuleTypestring

策略类型。

枚举值:
  • prc进程
  • domain域名
domain
Policystring

策略类型。

枚举值:
  • allow允许
  • block拒绝
allow
Recordingstring

是否开启录屏。

枚举值:
  • ALLTIME全程录屏,从登录桌面开始到退出桌面。
  • PERIOD间隔录屏,需设置录屏开始和结束时间。
  • OFF不开启录屏。
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

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

枚举值:
  • off关闭
  • on开启 [默认值]
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 的时候填写。当 Scope 为 IP 时生效,否则不生效。

string

生效的 cidr block。

47.100.XX.XX/24
RecordingAudiostring

录制桌面声音选项,取值范围:

  • on:音画同期录制。
  • off:仅录制画面不录制声音。
枚举值:
  • off关闭声音录制[默认选项]
  • on开启声音录制
on
InternetCommunicationProtocolstring

网络通信协议。取值范围:

  • TCP:只允许使用 TCP。
  • BOTH:允许自动在 TCP 和 UDP 之间切换。

默认值:TCP。

BOTH
VideoRedirectstring

多媒体重定向。取值范围: on:打开媒体重定向。 off:关闭媒体重定向。

off
WatermarkTransparencyValueinteger

水印透明度,值越大,透明度越小。 取值范围: 10~100。

10
WatermarkColorinteger

水印字体颜色。 取值范围: 0~16777215。

0
WatermarkFontSizeinteger

水印字体大小。 取值范围:10~20。

10
WatermarkFontStylestring

水印字体样式, 取值范围:

  • plain,普通。
  • bold,加粗。
plain
WatermarkDegreedouble

水印倾斜度。取值范围:-10~-30 。

-10
WatermarkRowAmountinteger

水印行数,暂不生效。

5
EndUserApplyAdminCoordinatestring

用户申请管理员协助开关,取值范围: on:开启。 off:关闭。

on
EndUserGroupCoordinatestring

用户之间流协同开关,取值范围: on:开启。 off:关闭。

on
CpuProtectedModestring

CPU 保护模式开关,取值范围: on:开启。 off:关闭。

on
CpuRateLimitinteger

CPU 整体使用率,取值范围: 70 ~ 90。

70
CpuSampleDurationinteger

CPU 整体采样时长,取值范围: 10 ~ 60。

10
CpuSingleRateLimitinteger

CPU 单核使用率,取值范围: 70 ~ 100。

70
CpuDownGradeDurationinteger

CPU 降频时长,取值范围: 30 ~ 120。

30
CpuProcessorsarray

不受 CPU 使用率限制约束进程白名单。

string

进程名。

chrome.exe
MemoryProtectedModestring

内存保护模式开关,取值范围: on:开启。 off:关闭。

on
MemoryRateLimitinteger

内存整体使用率,取值范围: 70 ~ 90。

70
MemorySampleDurationinteger

内存整体采样时长,取值范围: 30 ~ 60。

30
MemorySingleRateLimitinteger

单个进程内存使用率,取值范围: 30 ~ 60。

30
MemoryDownGradeDurationinteger

单个进程内存降频时长,取值范围: 30 ~ 120。

30
MemoryProcessorsarray

不受内存使用率限制约束进程白名单。

string

进程名。

notepad.exe
WatermarkSecuritystring

盲水印安全优先规则,取值范围: on:开启。 off:关闭。

on
WatermarkAntiCamstring

盲水印防拍照功能,取值范围: on:开启。 off:关闭。

off
WatermarkPowerstring

盲水印增强功能,取值范围: low:低。 medium:中。 high:高。

medium
RecordingUserNotifystring

录屏客户端消息通知功能,取值范围: on:开启。 off:关闭。

off
RecordingUserNotifyMessagestring

录屏客户端通知内容。默认无需填写。

您的桌面正在被录屏
AdminAccessstring

用户登录桌面后是否具有管理员权限

说明 该功能处于定向邀测中,暂不对外开放。
deny

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "DescribePolicyGroups": [
    {
      "PolicyStatus": "AVAILABLE",
      "Html5Access": "off",
      "WatermarkType": "EndUserId",
      "PreemptLogin": "off",
      "WatermarkCustomText": "test",
      "Clipboard": "readwrite",
      "DomainList": "off",
      "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
        }
      ],
      "DomainResolveRuleType": "on",
      "DomainResolveRule": [
        {
          "Domain": "*.com",
          "Policy": "allow",
          "Description": "测试规则"
        }
      ],
      "NetRedirectRule": [
        {
          "Domain": "*.com",
          "RuleType": "domain",
          "Policy": "allow"
        }
      ],
      "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",
      "VideoRedirect": "off",
      "WatermarkTransparencyValue": 10,
      "WatermarkColor": 0,
      "WatermarkFontSize": 10,
      "WatermarkFontStyle": "plain",
      "WatermarkDegree": -10,
      "WatermarkRowAmount": 5,
      "EndUserApplyAdminCoordinate": "on",
      "EndUserGroupCoordinate": "on",
      "CpuProtectedMode": "on",
      "CpuRateLimit": 70,
      "CpuSampleDuration": 10,
      "CpuSingleRateLimit": 70,
      "CpuDownGradeDuration": 30,
      "CpuProcessors": [
        "chrome.exe"
      ],
      "MemoryProtectedMode": "on",
      "MemoryRateLimit": 70,
      "MemorySampleDuration": 30,
      "MemorySingleRateLimit": 30,
      "MemoryDownGradeDuration": 30,
      "MemoryProcessors": [
        "notepad.exe"
      ],
      "WatermarkSecurity": "on",
      "WatermarkAntiCam": "off",
      "WatermarkPower": "medium",
      "RecordingUserNotify": "off",
      "RecordingUserNotifyMessage": "您的桌面正在被录屏",
      "AdminAccess": "deny"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-01-05OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-09-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-04-24OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-14OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-11-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-10-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-01-11OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-11-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈