DescribePolicyGroups - 查询云电脑策略详细信息

查询云电脑策略的详细信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

cn-hangzhou
MaxResultsinteger

分页查询时每页行数。

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

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

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdarray

云电脑策略 ID 列表。

string

云电脑策略 ID。

system-all-enabled-policy
Scopestring

云电脑策略的生效范围。

枚举值:
  • ALL全部策略
  • IP根据IP生效
  • GLOBAL全局生效 [默认值]
GLOBAL

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
DescribePolicyGroupsarray<object>

云电脑策略的详细信息。

DescribePolicyGroupobject

云电脑策略的详细信息。

PolicyStatusstring

云电脑策略状态。

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

Web 客户端访问策略。

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

水印类型。

枚举值:
  • EndUserId用户名
  • Custom自定义文本
  • DesktopIp云电脑IP地址
  • ClientIp客户端IP地址
  • HostName云电脑ID后15位
  • ClientTime云电脑当前时间
EndUserId
PreemptLoginstring

云电脑抢占策略。

说明 为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占,即该配置默认为off,且不可修改。
枚举值:
  • off禁止抢占
off
WatermarkCustomTextstring

若参数WatermarkType传入custom,则必须同时通过参数WatermarkCustomText传入自定义文本的内容。

custom-watermark
Clipboardstring

剪贴板权限。

枚举值:
  • read单向允许。可以将本地内容复制到云电脑,不能将云电脑内容复制到本地
  • readwrite双向允许。可以将本地内容复制到云电脑,也可以将云电脑内容复制到本地
  • write单向允许。可以将云电脑内容复制到本地,不能将本地内容复制到云电脑
  • off双向禁止。云电脑和本地之间无法进行复制操作 [默认值]
off
PolicyGroupIdstring

云电脑策略 ID。

pg-gx2x1dhsmthe9****
PrinterRedirectionstring

打印机重定向策略。

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

水印显示的深浅程度。

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

Web 客户端文传输策略。

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

USB 重定向。

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

云电脑策略类型。

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

水印。

枚举值:
  • blind开启盲水印
  • off关闭水印
  • on开启明水印
on
VisualQualitystring

图像显示质量策略。

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

关联了该策略的云电脑数量。仅自定义策略会返回结果。

1
Namestring

云电脑策略名称。

testPolicyGroupName
LocalDrivestring

本地磁盘映射权限。

枚举值:
  • read只读。云电脑上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件
  • readwrite读写。云电脑上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件
  • off关闭。云电脑上没有本地磁盘的映射 [默认值]
readwrite
AuthorizeSecurityPolicyRulesarray<object>

安全组管控规则列表。

AuthorizeSecurityPolicyRuleobject

安全组管控规则列表。

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
AuthorizeAccessPolicyRulesarray<object>

客户端 IP 白名单列表。仅白名单网段内的 IP 地址可访问云电脑。

AuthorizeAccessPolicyRuleobject

客户端访问 IP 白名单。

Descriptionstring

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

test
CidrIpstring

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

47.100.XX.XX/16
ClientTypesarray<object>

登录方式管控列表。用于控制可通过哪些客户端访问云电脑。

ClientTypeobject

登录方式管控规则。

Statusstring

是否允许某一类型的客户端连接云电脑。

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

客户端类型。

枚举值:
  • html5Web客户端
  • androidAndroid客户端
  • windowsWindows客户端
  • iosiOS客户端
  • macosmacOS客户端
windows
PreemptLoginUsersarray

可抢占云电脑的一组用户的用户名。

PreemptLoginUserstring

可抢占云电脑的用户的用户名。

Alice
GpuAccelerationstring

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

枚举值:
  • off关闭
  • on开启
off
UsbSupplyRedirectRulearray<object>

USB 重定向规则。

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
DomainResolveRulearray<object>

域名解析策略列表。

DomainResolveRuleobject

域名解析策略详情。

Domainstring

域名。

*.example.com
Policystring

解析策略。

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

策略描述。

测试规则
NetRedirectRulearray<object>

网络重定向策略列表。

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

网络重定向策略详情。

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

策略内容。

*.example.com
RuleTypestring

策略类型。

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

策略类型。

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

是否开启录屏。

枚举值:
  • byaction_cmd_ft用户操作录屏(执行命令和传输文件时均触发)
  • ALLTIME全程录屏,从连接云电脑开始到断开云电脑连接
  • PERIOD间隔录屏,需设置录屏开始和结束时间
  • byaction_commands用户操作录屏(仅执行命令时触发)
  • OFF不开启录屏
  • byaction_file_transfer用户操作录屏(仅传输文件时触发)
OFF
RecordingStartTimestring

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

08:00:00
RecordingEndTimestring

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

08:59:00
RecordingFpslong

录屏帧率。单位:FPS(帧/秒)。

枚举值:
  • 22
  • 55
  • 1010
  • 1515
5
RecordingExpireslong

录屏文件的保留时间。取值范围为 1~180 天。

15
CameraRedirectstring

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

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

网络重定向。

说明 该功能处于定向邀测中,暂不对外开放。
枚举值:
  • off关闭 [默认值]
  • on开启
off
AppContentProtectionstring

是否开启防截屏功能。

枚举值:
  • off关闭 [默认值]
  • on开启
off
RecordContentstring

是否开启自定义录屏。

枚举值:
  • off关闭 [默认值]
  • on开启
off
RecordContentExpireslong

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

30
RemoteCoordinatestring

远程协助键鼠控制权限。

枚举值:
  • optionalControl默认关闭,可以点击申请键鼠操作权限打开
  • fullControl完全控制
  • disableControl不控制
fullControl
RecordingDurationinteger

录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到 300MB 时优先滚动更新。

枚举值:
  • 1010
  • 2020
  • 3030
  • 6060
10
Scopestring

策略的生效范围。

枚举值:
  • IP根据IP生效
  • GLOBAL全局生效
GLOBAL
ScopeValuearray

Scope取值为IP的时候填写。当ScopeIP时生效,否则不生效。

scopeValuestring

生效的 CIDR Block。

47.100.XX.XX/24
RecordingAudiostring

录制云电脑声音选项。

枚举值:
  • off仅录制画面不录制声音 [默认值]
  • on开启声音录制
on
InternetCommunicationProtocolstring

网络通信协议。

枚举值:
  • TCP只允许使用TCP [默认值]
  • BOTH允许自动在TCP和UDP之间切换
BOTH
VideoRedirectstring

多媒体重定向。

枚举值:
  • off关闭媒体重定向
  • on打开媒体重定向
off
WatermarkTransparencyValueinteger

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

10
WatermarkColorinteger

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

0
WatermarkFontSizeinteger

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

10
WatermarkFontStylestring

水印字体样式。

枚举值:
  • plain普通
  • bold加粗
plain
WatermarkDegreedouble

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

-10
WatermarkRowAmountinteger

水印行数。

说明 此参数暂未开放使用。
5
EndUserApplyAdminCoordinatestring

用户申请管理员协助开关。

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

用户之间流协同开关。

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

CPU 保护模式开关。

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

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

70
CpuSampleDurationinteger

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

10
CpuSingleRateLimitinteger

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

70
CpuDownGradeDurationinteger

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

30
CpuProcessorsarray

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

cpuProcessorstring

进程名。

chrome.exe
MemoryProtectedModestring

内存保护模式开关。

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

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

70
MemorySampleDurationinteger

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

30
MemorySingleRateLimitinteger

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

30
MemoryDownGradeDurationinteger

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

30
MemoryProcessorsarray

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

memoryProcessorstring

进程名。

notepad.exe
WatermarkSecuritystring

盲水印安全优先规则。

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

盲水印防拍照功能。

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

盲水印增强功能。

枚举值:
  • high
  • low
  • medium
medium
RecordingUserNotifystring

录屏客户端消息通知功能。

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

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

您的云电脑正在被录屏
AdminAccessstring

用户连接云电脑后是否具有管理员权限。

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

云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30~7200,单位:秒。

120
DisplayModestring

显示模式。

枚举值:
  • clientCustom用户自主配置
  • adminOffice日常办公场景
  • adminDesign3D应用场景
  • adminCustom管理员自定义参数
adminCustom
StreamingModestring

流模式适配场景。

枚举值:
  • intelligent日常办公场景(智能模式)
  • smooth设计及3D应用场景(流畅优先)
smooth
ColorEnhancementstring

设计及 3D 应用场景选择是否开启色彩增强。

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

日常办公场景选择,是否开启平滑度增强。

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

设计及 3D 应用场景选择是否开启画质增强。

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

视频编码策略。

枚举值:
  • qualityFirst画面质量优先
  • bandwidthFirst码率策略优先
qualityFirst
TargetFpsinteger

目标帧率,取值范围:10~60。

30
VideoEncMinQPinteger

视频编码最小 QP,最高质量。取值范围:0~51。

20
VideoEncMaxQPinteger

视频编码最大 QP,画面最低质量,取值范围:0~51。

20
VideoEncAvgKbpsinteger

视频编码平均码率,取值范围:1000~50000。

1000
VideoEncPeakKbpsinteger

视频编码峰值码率,取值范围:1000~50000。

1000
DeviceRedirectsarray<object>

设备重定向规则列表。

DeviceRedirectobject

设备重定向规则。

DeviceTypestring

外设类型。

枚举值:
  • printer打印机
  • scanner扫描仪
  • camera摄像头
  • adbAndroid设备
camera
RedirectTypestring

重定向类型,取值范围:

  • usbRedirect,usb 重定向。
  • deviceRedirect,设备重定向。
  • off,关闭。
usbRedirect
DeviceRulesarray<object>

自定义外设规则列表。

DeviceRuleobject

自定义外设规则。

DeviceTypestring

外设类型。

枚举值:
  • usbKeyUKey
  • other其他
  • graphicsTablet手绘板
  • printer打印机
  • cardReader读卡器
  • scanner扫描仪
  • storage存储设备
  • camera摄像头
  • adbAndroid设备
  • networkInterfaceCard网卡设备
storage
DeviceNamestring

设备名称

sandisk
DeviceVidstring

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

0x0781
DevicePidstring

产品 ID。

0x55b1
RedirectTypestring

重定向类型。

枚举值:
  • deviceRedirect设备重定向
  • usbRedirectUSB重定向
  • off关闭重定向
usbRedirect
OptCommandstring

链接优化指令。

2:0
DomainListstring

访问域名权限管控。域名支持通配符(*),多个域名之间以半角逗号隔开。

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

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "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": 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": "*.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"
        }
      ],
      "WyAssistant": "",
      "ResourceRegionId": "",
      "DomainList": "off"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-27OpenAPI 返回结构发生变更查看变更详情
2024-08-05OpenAPI 返回结构发生变更查看变更详情
2024-07-19OpenAPI 返回结构发生变更查看变更详情
2024-07-01OpenAPI 返回结构发生变更查看变更详情
2024-01-26OpenAPI 返回结构发生变更查看变更详情
2024-01-05OpenAPI 返回结构发生变更查看变更详情
2023-09-20OpenAPI 返回结构发生变更查看变更详情
2023-04-24OpenAPI 返回结构发生变更查看变更详情
2023-03-14OpenAPI 返回结构发生变更查看变更详情
2022-11-04OpenAPI 返回结构发生变更查看变更详情
2022-10-08OpenAPI 返回结构发生变更查看变更详情
2022-01-11OpenAPI 返回结构发生变更查看变更详情
2021-11-30OpenAPI 返回结构发生变更查看变更详情