文档

CreatePolicyGroup - 创建云电脑策略

更新时间:

创建云电脑策略。

接口说明

云电脑策略是一组规则的集合,主要包含云电脑性能和安全方面的配置,例如磁盘映射、USB 重定向、水印等基础策略,以及 DNS 管控等规则。更多信息,请参见策略概述

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
Clipboardstring

剪贴板权限。

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

本地磁盘映射权限。

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

USB 重定向。

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

图像显示质量策略。

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

Web 客户端访问策略。

说明 推荐您使用ClientType相关参数统一管控登录方式。
枚举值:
  • off禁止 [默认值]
  • on允许
off
Html5FileTransferstring

Web 客户端文传输策略。

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

水印。

枚举值:
  • blind开启盲水印
  • off关闭水印 [默认值]
  • on开启明水印
off
Namestring

策略名称。

testPolicyGroupName
WatermarkTypestring

水印类型。最多可以选择 3 个类型,用半角逗号隔开。

说明 若传入custom,则必须同时通过参数WatermarkCustomText传入自定义文本的内容。
枚举值:
  • EndUserId用户名
  • Custom自定义文本
  • DesktopIp云电脑IP地址
  • ClientIp客户端IP地址
  • HostName云电脑ID的后15位
  • ClientTime云电脑当前时间
EndUserId
WatermarkTransparencystring

水印显示的深浅程度。

枚举值:
  • LIGHT较浅 [默认值]
  • DARK较深
  • MIDDLE普通
LIGHT
PreemptLoginstring

云电脑抢占策略。

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

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

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

打印机重定向策略。

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

允许抢占云电脑的一组用户的用户名,最多可以设置 5 个。

说明 为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占。
string

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

Alice
AuthorizeSecurityPolicyRulearray<object>

安全组管控规则列表。

object

安全组管控规则。

Typestring

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

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

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

枚举值:
  • drop拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接
  • accept允许策略,接收所有访问请求 [默认值]
accept
PortRangestring

安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:

  • TCP 协议或者 UDP 协议:端口取值范围为 1~65535。使用斜线(/)隔开起始端口和终止端口。例如:1/200。
  • ICMP 协议:端口为-1/-1。
  • GRE 协议:端口为-1/-1。
  • IpProtocol 取值为 all:端口为-1/-1。

典型应用的常用端口请参见常用端口

22/22
Descriptionstring

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

test
IpProtocolstring

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

枚举值:
  • TCPTCP协议
  • UDPUDP协议
  • ALL支持所有协议
  • GREGRE协议
  • ICMPICMP(IPv4)协议
tcp
Prioritystring

安全组管控规则的优先级。数字越小,代表优先级越高。
取值范围:1~60。
默认值:1。

1
CidrIpstring

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

47.100.XX.XX/16
AuthorizeAccessPolicyRulearray<object>

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

object

客户端 IP 白名单。

Descriptionstring

客户端 IP 白名单的描述信息。

华北分公司
CidrIpstring

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

47.100.XX.XX/16
ClientTypearray<object>

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

object

登录方式管控规则。

Statusstring

登录方式管控,设置是否允许使用某一类型的客户端登录云电脑。

说明 如果不设置ClientType相关参数,则默认允许所有类型的客户端登录云电脑。
枚举值:
  • OFF不允许
  • ON允许
ON
ClientTypestring

登录方式管控,设置客户端类型。

说明 如果不设置ClientType相关参数,则默认允许所有类型的客户端登录云电脑。
枚举值:
  • html5Web客户端
  • androidAndroid客户端
  • iosiOS客户端
  • windowsWindows客户端
  • macosmacOS客户端
windows
GpuAccelerationstring

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

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

USB 重定向规则。

object

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开启
OFF
DomainResolveRulearray<object>

域名解析策略详情。

object

域名解析策略。

Domainstring

域名。

*.example.com
Policystring

解析策略。

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

策略描述。

测试规则
Recordingstring

是否开启录屏。

枚举值:
  • byaction_cmd_ft用户操作录屏(执行命令和传输文件时均触发)
  • ALLTIME全程录屏,从连接云电脑开始到断开云电脑连接
  • session监听会话生命周期录屏
  • 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
2
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时生效,否则不生效。

string

生效的 CIDR Block 范围。

47.100.XX.XX/24
RecordingAudiostring

录制云电脑声音的选项。

枚举值:
  • off仅录制画面不录制声音
  • on音画同期录制
on
InternetCommunicationProtocolstring

网络通信协议。

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

多媒体重定向。

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

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

10
WatermarkColorinteger

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

0
WatermarkDegreedouble

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

-10
WatermarkFontSizeinteger

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

10
WatermarkFontStylestring

水印字体样式。

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

水印行数。

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

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

枚举值:
  • OFF关闭
  • ON开启
ON
EndUserGroupCoordinatestring

用户之间流协同开关。

枚举值:
  • OFF关闭
  • ON开启
ON
WatermarkSecuritystring

盲水印安全优先规则。

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

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

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

盲水印防拍照功能。

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

盲水印增强功能。

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

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

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

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

您的云电脑正在被录屏
MaxReconnectTimeinteger

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

120
DeviceRedirectsarray<object>

设备重定向规则列表。

object

设备重定向规则。

DeviceTypestring

外设类型。

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

重定向类型。

枚举值:
  • deviceRedirect设备重定向
  • usbRedirectUSB重定向
  • off关闭重定向
deviceRedirect
DeviceRulesarray<object>

自定义外设规则列表。

object

自定义外设规则。

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

返回参数

名称类型描述示例值
object

返回信息集合。

PolicyGroupIdstring

云电脑策略 ID。

pg-gx2x1dhsmthe9****
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "PolicyGroupId": "pg-gx2x1dhsmthe9****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-15API 内部配置变更,不影响调用查看变更详情
2024-08-05OpenAPI 入参发生变更查看变更详情
2024-07-19OpenAPI 入参发生变更查看变更详情
2024-07-01OpenAPI 入参发生变更查看变更详情
2024-01-26OpenAPI 入参发生变更查看变更详情
2024-01-05OpenAPI 入参发生变更查看变更详情
2023-09-20OpenAPI 入参发生变更查看变更详情
2023-07-31OpenAPI 入参发生变更查看变更详情
2022-11-04OpenAPI 入参发生变更查看变更详情
2022-10-08OpenAPI 入参发生变更查看变更详情
2022-01-11OpenAPI 入参发生变更查看变更详情
2021-11-30OpenAPI 入参发生变更查看变更详情