备案控制台
文档
产品文档
输入文档关键字查找
首页 无影云电脑 无影云电脑（专业版） 开发参考 API参考（云桌面管控） API目录 策略 CreatePolicyGroup - 创建策略

CreatePolicyGroup - 创建策略

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

创建策略。

接口说明

策略是一组安全规则的集合，可以控制终端用户使用云桌面的相关安全配置，包含 USB 重定向、水印等基础策略，以及安全组管控等规则。更多信息，请参见策略概述。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
Clipboardstring否

剪贴板权限。

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

本地磁盘映射权限。

枚举值：
  • read：只读。云桌面上有本地磁盘的映射，但是只能读取（复制）本地文件，不能修改本地文件。。
  • readwrite：读写。云桌面上有本地磁盘的映射，可以读取（复制）本地文件，也可以修改本地文件。。
  • off：关闭。云桌面上没有本地磁盘的映射。 [默认值]。
off
UsbRedirectstring否

USB 重定向。

枚举值：
  • off：关闭 [默认值]。
  • on：开启。
off
VisualQualitystring否

图像显示质量策略。

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

HTML5 客户端访问策略。

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

HTML5 客户端文件传输策略。

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

水印。

枚举值：
  • off：关闭 [默认值]。
  • on：开启。
off
Namestring否

策略名称。

testPolicyGroupName
WatermarkTypestring否

水印类型。支持同时选择多个类型，用英文逗号隔开。

枚举值：
  • EndUserId：显示用户名。
  • HostName：显示云桌面ID的后15位。
EndUserId
WatermarkTransparencystring否

水印显示的深浅程度。

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

桌面抢占策略。

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

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

  • off：关闭。

  • on：开启。

off
PrinterRedirectionstring否

打印机重定向策略。

枚举值：
  • off：关闭。
  • on：打开。
on
PreemptLoginUserarray否

允许抢占桌面的一组用户的用户名，最多可以设置 5 个。

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

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

Alice
AuthorizeSecurityPolicyRuleobject []否

安全组管控规则数组。

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否

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

枚举值：
  • TCP：TCP协议。
  • UDP：UDP协议。
  • ALL：支持所有协议。
  • GRE：GRE协议。
  • ICMP：ICMP（IPv4）协议。
tcp
Prioritystring否

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

1
CidrIpstring否

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

47.100.XX.XX/16
AuthorizeAccessPolicyRuleobject []否

客户端 IP 白名单数组。设置后，仅白名单网段内的 IP 地址可访问云桌面。

Descriptionstring否

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

华北分公司
CidrIpstring否

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

47.100.XX.XX/16
ClientTypeobject []否

登录方式管控数组。用于控制可通过哪些客户端访问云桌面。

Statusstring否

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

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

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

说明 如果不设置 ClientType 相关参数，则默认允许所有类型的客户端登录云桌面。
枚举值：
  • html5：Web客户端。
  • android：Android客户端。
  • linux：阿里云云终端。
  • ios：iOS客户端。
  • windows：Windows客户端。
  • macos：macOS客户端。
windows
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：开启。
OFF
DomainResolveRuleobject []否

域名解析策略详情。

Domainstring否

域名。

*.baidu.com
Policystring否

策略类型。

枚举值：
  • allow：允许。
  • block：拒绝。
allow
Descriptionstring否

策略描述。

策略描述。
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：2。
  • 5：5。
  • 10：10。
  • 15：15。
2
RecordingExpireslong否

录屏文件的过期时间，单位为天。

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否

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

15
Scopestring否

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

  • GLOBAL：全局生效。
  • IP：根据 IP 生效。
GLOBAL
ScopeValuearray否

Scope 取值为 IP 的时候填写。

string否

生效的 cidr block 范围。

47.100.XX.XX/24
RecordingAudiostring否

录制桌面声音选项，取值范围：

  • on：音画同期录制。
  • off：仅录制画面不录制声音。
on
InternetCommunicationProtocolstring否

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

both
VideoRedirectstring否

多媒体重定向。取值范围：

  • on：打开媒体重定向。
  • off：关闭媒体重定向。
on
WatermarkTransparencyValueinteger否

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

10
WatermarkColorinteger否

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

0
WatermarkDegreedouble否

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

-10
WatermarkFontSizeinteger否

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

10
WatermarkFontStylestring否

水印字体样式， 取值范围：

  • plain，普通。
  • bold，加粗。
plain
WatermarkRowAmountinteger否

水印行数，暂不生效。

5
EndUserApplyAdminCoordinatestring否

用户申请管理员协助开关，取值范围： ON：开启。 OFF：关闭。

ON
EndUserGroupCoordinatestring否

用户之间流协同开关，取值范围： ON：开启。 OFF：关闭。

ON
WatermarkSecuritystring否

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

on
AdminAccessstring否

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

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

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

off
WatermarkPowerstring否

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

medium
RecordingUserNotifystring否

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

off
RecordingUserNotifyMessagestring否

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

您的桌面正在被录屏

返回参数

名称类型描述示例值
object

返回信息集合。

PolicyGroupIdstring

策略 ID。

pg-gx2x1dhsmthe9****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-26OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：WatermarkAntiCam
    新增入参：WatermarkPower
    新增入参：RecordingUserNotify
    新增入参：RecordingUserNotifyMessage
2024-01-05OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：AdminAccess
2023-09-20OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：WatermarkSecurity
2023-07-31OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：DomainResolveRuleType
    新增入参：DomainResolveRule
2022-11-04OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：RecordingAudio
2022-10-08OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：RecordingDuration
2022-01-11OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：Recording
    新增入参：RecordingStartTime
    新增入参：RecordingEndTime
    新增入参：RecordingFps
    新增入参：CameraRedirect
2021-11-30OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更。
    新增入参：GpuAcceleration
文档推荐
  • 本页导读 （0）
文档反馈