查询云电脑策略的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:DescribePolicyGroups |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 |
cn-hangzhou |
| MaxResults |
integer |
否 |
分页查询时每页行数。
|
10 |
| NextToken |
string |
否 |
查询凭证(Token)。取值为上一次调用该接口返回的 NextToken 参数值,初次调用接口时无需设置该参数。 |
caeba0bbb2be03f84eb48b699f0a4883 |
| PolicyGroupId |
array |
否 |
云电脑策略 ID 列表。 |
system-all-enabled-policy |
|
string |
否 |
云电脑策略 ID。 |
system-all-enabled-policy |
|
| Scope |
string |
否 |
云电脑策略的生效范围。 枚举值:
|
GLOBAL |
| ExternalPolicyGroupIds |
array |
否 |
要在查询结果中排除的云电脑策略 ID 列表。 |
|
|
string |
否 |
要在查询结果中排除的云电脑策略 ID。 |
pg-0cid8v30p16k4**** |
|
| PageNumber |
integer |
否 |
||
| PageSize |
integer |
否 |
||
| BusinessChannel |
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息集合。 |
||
| NextToken |
string |
下一个查询开始的 Token,NextToken 为空表示没有下一个。 |
caeba0bbb2be03f84eb48b699f0a**** |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| Count |
integer |
||
| PageNumber |
integer |
||
| PageSize |
integer |
||
| DescribePolicyGroups |
array<object> |
云电脑策略的详细信息。 |
|
|
array<object> |
云电脑策略的详细信息。 |
||
| PolicyStatus |
string |
云电脑策略状态。 枚举值:
|
AVAILABLE |
| Html5Access |
string |
Web 客户端访问策略。 枚举值:
|
off |
| WatermarkType |
string |
水印类型。 枚举值:
|
EndUserId |
| PreemptLogin |
string |
云电脑抢占策略。 说明
为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占,即该配置默认为 枚举值:
|
off |
| WatermarkCustomText |
string |
若参数 |
custom-watermark |
| Clipboard |
string |
剪贴板权限。 枚举值:
|
off |
| PolicyGroupId |
string |
云电脑策略 ID。 |
pg-gx2x1dhsmthe9**** |
| PrinterRedirection |
string |
打印机重定向策略。 枚举值:
|
on |
| WatermarkTransparency |
string |
水印显示的深浅程度。 枚举值:
|
LIGHT |
| Html5FileTransfer |
string |
Web 客户端文传输策略。 枚举值:
|
off |
| UsbRedirect |
string |
USB 重定向。 枚举值:
|
on |
| PolicyGroupType |
string |
云电脑策略类型。 枚举值:
|
SYSTEM |
| Watermark |
string |
水印。 枚举值:
|
on |
| VisualQuality |
string |
图像显示质量策略。 枚举值:
|
medium |
| EdsCount |
integer |
关联了该策略的云电脑和云电脑池的总数量。仅自定义策略会返回结果。 |
2 |
| Name |
string |
云电脑策略名称。 |
testPolicyGroupName |
| LocalDrive |
string |
本地磁盘映射权限。 枚举值:
|
readwrite |
| AuthorizeSecurityPolicyRules |
array<object> |
安全组管控规则列表。 |
|
|
object |
安全组管控规则列表。 |
||
| Type |
string |
安全组管控规则的规则方向。 枚举值:
|
inflow |
| Policy |
string |
安全组管控规则的授权策略。 枚举值:
|
accept |
| Description |
string |
安全组管控规则的描述信息。 |
test |
| PortRange |
string |
安全组管控规则的端口范围。 |
22/22 |
| IpProtocol |
string |
安全组管控规则的协议类型。 枚举值:
|
tcp |
| Priority |
string |
安全组管控规则的优先级,数字越小,代表优先级越高。 |
1 |
| CidrIp |
string |
安全组管控规则的对象,CIDR 格式的 IPv4 地址段。 |
47.100.XX.XX/16 |
| AuthorizeAccessPolicyRules |
array<object> |
客户端 IP 白名单列表。仅白名单网段内的 IP 地址可访问云电脑。 |
|
|
object |
客户端访问 IP 白名单。 |
||
| Description |
string |
客户端访问 IP 地址段备注信息。 |
test |
| CidrIp |
string |
客户端访问 IP 地址段。格式为 CIDR 格式的 IPv4 地址段。 |
47.100.XX.XX/16 |
| ClientTypes |
array<object> |
登录方式管控列表。用于控制可通过哪些客户端访问云电脑。 |
|
|
object |
登录方式管控规则。 |
||
| Status |
string |
是否允许某一类型的客户端连接云电脑。 枚举值:
|
ON |
| ClientType |
string |
客户端类型。 枚举值:
|
windows |
| PreemptLoginUsers |
array |
可抢占云电脑的一组用户的用户名。 |
|
|
string |
可抢占云电脑的用户的用户名。 |
Alice |
|
| GpuAcceleration |
string |
是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。 枚举值:
|
off |
| UsbSupplyRedirectRule |
array<object> |
USB 重定向规则。 |
|
|
object |
USB 重定向规则。 |
||
| VendorId |
string |
生产厂商 ID。参见Valid USB Vendor IDs (VIDs)。 |
04** |
| ProductId |
string |
产品 ID。 |
08** |
| Description |
string |
规则描述。 |
测试规则 |
| UsbRedirectType |
integer |
USB 重定向类型。 枚举值:
|
1 |
| DeviceClass |
string |
设备类别,当 |
0Eh |
| DeviceSubclass |
string |
设备子类别,当 |
xxh |
| UsbRuleType |
integer |
USB 重定向规则类型。 枚举值:
|
1 |
| DomainResolveRuleType |
string |
域名解析策略开关。 枚举值:
|
on |
| DomainResolveRule |
array<object> |
域名解析策略列表。 |
|
|
object |
域名解析策略详情。 |
||
| Domain |
string |
域名。 |
*.example.com |
| Policy |
string |
解析策略。 枚举值:
|
allow |
| Description |
string |
策略描述。 |
测试规则 |
| NetRedirectRule |
array<object> |
网络重定向策略列表。 说明
该功能处于定向邀测中,暂不对外开放。 |
|
|
object |
网络重定向策略详情。 说明
该功能处于定向邀测中,暂不对外开放。 |
||
| Domain |
string |
策略内容。 |
*.example.com |
| RuleType |
string |
策略类型。 枚举值:
|
domain |
| Policy |
string |
策略类型。 枚举值:
|
allow |
| Recording |
string |
是否开启录屏。 枚举值:
|
OFF |
| RecordingStartTime |
string |
录屏开始时间,取值:HH:MM:SS。只有 Recording 取值是 PERIOD 时,该返回值有实际意义。 |
08:00:00 |
| RecordingEndTime |
string |
录屏结束时间,取值:HH:MM:SS。只有 Recording 取值是 PERIOD 时,该返回值有实际意义。 |
08:59:00 |
| RecordingFps |
integer |
录屏帧率。单位:FPS(帧/秒)。 枚举值:
|
5 |
| RecordingExpires |
integer |
录屏文件的保留时间。取值范围为 1~180 天。 |
15 |
| CameraRedirect |
string |
是否开启本地摄像头重定向。 枚举值:
|
on |
| NetRedirect |
string |
网络重定向。 说明
该功能处于定向邀测中,暂不对外开放。 枚举值:
|
off |
| AppContentProtection |
string |
是否开启防截屏功能。 枚举值:
|
off |
| RecordContent |
string |
是否开启自定义录屏。 枚举值:
|
off |
| RecordContentExpires |
integer |
自定义录屏的文件过期时间,默认 30 天。 |
30 |
| RemoteCoordinate |
string |
远程协助键鼠控制权限。 枚举值:
|
fullControl |
| RecordingDuration |
integer |
录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到 300MB 时优先滚动更新。 枚举值:
|
10 |
| Scope |
string |
策略的生效范围。 枚举值:
|
GLOBAL |
| ScopeValue |
array |
|
|
|
string |
生效的 CIDR Block。 |
47.100.XX.XX/24 |
|
| RecordingAudio |
string |
录制云电脑声音选项。 枚举值:
|
on |
| InternetCommunicationProtocol |
string |
网络通信协议。 枚举值:
|
BOTH |
| VideoRedirect |
string |
多媒体重定向。 枚举值:
|
off |
| WatermarkTransparencyValue |
integer |
水印透明度,值越大,透明度越小。 取值范围: 10~100。 |
10 |
| WatermarkColor |
integer |
水印字体颜色。 取值范围: 0~16777215。 |
0 |
| WatermarkFontSize |
integer |
水印字体大小。 取值范围:10~20。 |
10 |
| WatermarkFontStyle |
string |
水印字体样式。 枚举值:
|
plain |
| WatermarkDegree |
number |
水印倾斜度。取值范围:-10~-30 。 |
-10 |
| WatermarkRowAmount |
integer |
水印行数。 说明
此参数暂未开放使用。 |
5 |
| EndUserApplyAdminCoordinate |
string |
用户申请管理员协助开关。 枚举值:
|
on |
| EndUserGroupCoordinate |
string |
用户之间流协同开关。 枚举值:
|
on |
| CpuProtectedMode |
string |
CPU 保护模式开关。 枚举值:
|
on |
| CpuRateLimit |
integer |
CPU 整体使用率百分比,取值范围: 70~90。 |
70 |
| CpuSampleDuration |
integer |
CPU 整体采样时长,取值范围: 10~60。单位:秒。 |
10 |
| CpuSingleRateLimit |
integer |
CPU 单核使用率百分比,取值范围: 70~100。 |
70 |
| CpuDownGradeDuration |
integer |
CPU 降频时长,取值范围: 30~120。单位:秒。 |
30 |
| CpuProcessors |
array |
不受 CPU 使用率限制约束进程白名单。 |
|
|
string |
进程名。 |
chrome.exe |
|
| MemoryProtectedMode |
string |
内存保护模式开关。 枚举值:
|
on |
| MemoryRateLimit |
integer |
内存整体使用率百分比,取值范围: 70~90。 |
70 |
| MemorySampleDuration |
integer |
内存整体采样时长,取值范围: 30~60。单位:秒。 |
30 |
| MemorySingleRateLimit |
integer |
单个进程内存使用率百分比,取值范围: 30~60。 |
30 |
| MemoryDownGradeDuration |
integer |
单个进程内存降频时长,取值范围: 30~120。单位:秒。 |
30 |
| MemoryProcessors |
array |
不受内存使用率限制约束进程白名单。 |
|
|
string |
进程名。 |
notepad.exe |
|
| WatermarkSecurity |
string |
盲水印安全优先规则。 枚举值:
|
on |
| WatermarkAntiCam |
string |
盲水印防拍照功能。 枚举值:
|
off |
| WatermarkPower |
string |
盲水印增强功能。 枚举值:
|
medium |
| RecordingUserNotify |
string |
录屏客户端消息通知功能。 枚举值:
|
off |
| RecordingUserNotifyMessage |
string |
录屏客户端通知内容。默认无需填写。 |
您的云电脑正在被录屏 |
| AdminAccess |
string |
用户连接云电脑后是否具有管理员权限。 说明
该功能处于定向邀测中,暂不对外开放。 |
deny |
| MaxReconnectTime |
integer |
云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30~7200,单位:秒。 |
120 |
| DisplayMode |
string |
显示模式。 枚举值:
|
adminCustom |
| StreamingMode |
string |
流模式适配场景。 枚举值:
|
smooth |
| ColorEnhancement |
string |
设计及 3D 应用场景选择是否开启色彩增强。 枚举值:
|
off |
| SmoothEnhancement |
string |
日常办公场景选择,是否开启平滑度增强。 枚举值:
|
off |
| QualityEnhancement |
string |
设计及 3D 应用场景选择是否开启画质增强。 枚举值:
|
off |
| VideoEncPolicy |
string |
视频编码策略。 枚举值:
|
qualityFirst |
| TargetFps |
integer |
目标帧率,取值范围:10~60。 |
30 |
| VideoEncMinQP |
integer |
视频编码最小 QP,最高质量。取值范围:0~51。 |
20 |
| VideoEncMaxQP |
integer |
视频编码最大 QP,画面最低质量,取值范围:0~51。 |
20 |
| VideoEncAvgKbps |
integer |
视频编码平均码率,取值范围:1000~50000。 |
1000 |
| VideoEncPeakKbps |
integer |
视频编码峰值码率,取值范围:1000~50000。 |
1000 |
| DeviceRedirects |
array<object> |
设备重定向规则列表。 |
|
|
object |
设备重定向规则。 |
||
| DeviceType |
string |
外设类型。 枚举值:
|
camera |
| RedirectType |
string |
重定向类型,取值范围:
|
usbRedirect |
| DeviceRules |
array<object> |
自定义外设规则列表。 |
|
|
object |
自定义外设规则。 |
||
| DeviceType |
string |
外设类型。 枚举值:
|
storage |
| DeviceName |
string |
设备名称 |
sandisk |
| DeviceVid |
string |
生产厂商 ID。参见Valid USB Vendor IDs (VIDs)。 |
0x0781 |
| DevicePid |
string |
产品 ID。 |
0x55b1 |
| RedirectType |
string |
重定向类型。 枚举值:
|
usbRedirect |
| OptCommand |
string |
链接优化指令。 |
2:0 |
| Platforms |
string |
||
| WyAssistant |
string |
是否在云电脑悬浮球内提供无影 AI 助手功能入口。 枚举值:
|
on |
| ResourceRegionId |
string |
云电脑策略所属的地域。 说明
若为无地域策略,则该值为 |
center |
| DomainList |
string |
访问域名权限管控。域名支持通配符(*),多个域名之间以半角逗号隔开。 枚举值:
|
off |
| StatusMonitor |
string |
是否在云电脑悬浮球内提供状态监控功能入口。 枚举值:
|
on |
| MobileRestart |
string |
通过移动端(包括 Android 客户端和 iOS 客户端)连接云电脑时,是否在云电脑悬浮球内提供重启按钮。 说明
仅适用于 V7.4 或更高版本的移动端。 枚举值:
|
off |
| MobileShutdown |
string |
通过移动端(包括 Android 客户端和 iOS 客户端)连接云电脑时,是否在云电脑悬浮球内提供关机按钮。 说明
仅适用于 V7.4 或更高版本的移动端。 枚举值:
|
off |
| DesktopCount |
integer |
已关联该策略的云电脑数量。 |
1 |
| DesktopGroupCount |
integer |
已关联该策略的云电脑池数量。 |
1 |
| ResourceGroupCount |
integer |
已关联该策略的资源组数量。 |
1 |
| RecordEventFilePaths |
array |
录屏审计中的文件监控绝对路径列表。 |
|
|
string |
录屏审计中的文件监控绝对路径。 |
d:/data |
|
| RecordEventRegisters |
array |
录屏审计中的注册表监控绝对路径列表。 |
|
|
string |
录屏审计中的注册表监控绝对路径。 |
计算机\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\USBSTOR |
|
| RecordEventDuration |
integer |
录屏审计中检测到事件发生后录屏的时长。单位:分钟。取值范围:10~60。 |
10 |
| ResetDesktop |
string |
重置云电脑。 |
null |
| FileTransfer |
string |
文件传输。 |
null |
| DeviceConnectHint |
string |
||
| ResolutionModel |
string |
||
| ResolutionWidth |
integer |
||
| ResolutionHeight |
integer |
||
| FileMigrate |
string |
||
| WuyingKeeper |
string |
||
| InternetPrinter |
string |
||
| SafeMenu |
string |
||
| ScreenDisplayMode |
string |
||
| ClientControlMenu |
string |
||
| FileTransferSpeedLocation |
string |
||
| FileTransferAddress |
string |
||
| FileTransferSpeed |
string |
||
| CpdDriveClipboard |
string |
||
| UseTime |
string |
||
| AutoReconnect |
string |
客户端自动重连配置项 |
off |
| MobileWuyingKeeper |
string |
移动端无影管家开关 |
off |
| MobileSafeMenu |
string |
移动端 Windows 安全控制开关 |
off |
| MobileWyAssistant |
string |
移动端无影小颖开关 |
off |
| ExternalDrive |
string |
||
| ClientCreateSnapshot |
string |
||
| WatermarkShadow |
string |
||
| AcademicProxy |
string |
||
| ModelLibrary |
string |
||
| PortProxy |
string |
||
| DiskOverload |
string |
||
| CpuOverload |
string |
||
| MemoryOverload |
string |
||
| ResolutionDpi |
integer |
||
| RecordEventLevels |
array<object> |
录屏事件等级开关 |
|
|
object |
|||
| EventType |
string |
事件类型 |
|
| EventLevel |
string |
事件等级 |
|
| RecordEventFileExts |
array |
录屏事件后缀 |
|
|
string |
|||
| HoverConfigMsg |
string |
||
| MultiScreen |
string |
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"Count": 0,
"PageNumber": 0,
"PageSize": 0,
"DescribePolicyGroups": [
{
"PolicyStatus": "AVAILABLE",
"Html5Access": "off",
"WatermarkType": "EndUserId",
"PreemptLogin": "off",
"WatermarkCustomText": "custom-watermark",
"Clipboard": "off",
"PolicyGroupId": "pg-gx2x1dhsmthe9****",
"PrinterRedirection": "on",
"WatermarkTransparency": "LIGHT",
"Html5FileTransfer": "off",
"UsbRedirect": "on",
"PolicyGroupType": "SYSTEM",
"Watermark": "on",
"VisualQuality": "medium",
"EdsCount": 2,
"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": "*.example.com",
"Policy": "allow",
"Description": "测试规则"
}
],
"NetRedirectRule": [
{
"Domain": "*.example.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",
"MaxReconnectTime": 120,
"DisplayMode": "adminCustom",
"StreamingMode": "smooth",
"ColorEnhancement": "off",
"SmoothEnhancement": "off",
"QualityEnhancement": "off",
"VideoEncPolicy": "qualityFirst",
"TargetFps": 30,
"VideoEncMinQP": 20,
"VideoEncMaxQP": 20,
"VideoEncAvgKbps": 1000,
"VideoEncPeakKbps": 1000,
"DeviceRedirects": [
{
"DeviceType": "camera",
"RedirectType": "usbRedirect"
}
],
"DeviceRules": [
{
"DeviceType": "storage",
"DeviceName": "sandisk",
"DeviceVid": "0x0781",
"DevicePid": "0x55b1",
"RedirectType": "usbRedirect",
"OptCommand": "2:0",
"Platforms": ""
}
],
"WyAssistant": "on",
"ResourceRegionId": "center",
"DomainList": "off",
"StatusMonitor": "on",
"MobileRestart": "off",
"MobileShutdown": "off",
"DesktopCount": 1,
"DesktopGroupCount": 1,
"ResourceGroupCount": 1,
"RecordEventFilePaths": [
"d:/data"
],
"RecordEventRegisters": [
"计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR"
],
"RecordEventDuration": 10,
"ResetDesktop": "null",
"FileTransfer": "null",
"DeviceConnectHint": "",
"ResolutionModel": "",
"ResolutionWidth": 0,
"ResolutionHeight": 0,
"FileMigrate": "",
"WuyingKeeper": "",
"InternetPrinter": "",
"SafeMenu": "",
"ScreenDisplayMode": "",
"ClientControlMenu": "",
"FileTransferSpeedLocation": "",
"FileTransferAddress": "",
"FileTransferSpeed": "",
"CpdDriveClipboard": "",
"UseTime": "",
"AutoReconnect": "off",
"MobileWuyingKeeper": "off",
"MobileSafeMenu": "off",
"MobileWyAssistant": "off",
"ExternalDrive": "",
"ClientCreateSnapshot": "",
"WatermarkShadow": "",
"AcademicProxy": "",
"ModelLibrary": "",
"PortProxy": "",
"DiskOverload": "",
"CpuOverload": "",
"MemoryOverload": "",
"ResolutionDpi": 0,
"RecordEventLevels": [
{
"EventType": "",
"EventLevel": ""
}
],
"RecordEventFileExts": [
""
],
"HoverConfigMsg": "",
"MultiScreen": ""
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。