CreatePolicyGroup - 创建策略

创建策略。

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

地域ID。

cn-hangzhou
Clipboardstring

剪贴板权限。

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

本地磁盘映射权限。

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

USB重定向。

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

图像显示质量策略。

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

HTML5客户端访问策略。

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

HTML5客户端文件传输策略。

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

水印。

off
枚举值:
- off: 关闭 [默认值]
- on: 开启
Namestring

策略名称。

testPolicyGroupName
WatermarkTypestring

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

EndUserId
枚举值:
- EndUserId: 显示用户名
- HostName: 显示云桌面ID的后15位
WatermarkTransparencystring

水印显示的深浅程度。

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

桌面抢占策略。

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

设置域名黑白名单,域名支持*通配符,多个域名之间以英文逗号隔开。取值范围:

  • [black:],example1.com,example2.com:域名黑名单。不允许云桌面访问黑名单中的域名。

  • [white:],example1.com,example2.com:域名白名单。只允许云桌面访问白名单中的域名。

[black:],example.com
PrinterRedirectionstring

打印机重定向策略。

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

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

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

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

Alice
AuthorizeSecurityPolicyRulearray

安全组管控规则数组。

object

安全组管控规则对象。

Typestring

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

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

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

accept
枚举值:
- drop: 拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接。
- 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: TCP协议
- UDP: UDP协议
- ALL: 支持所有协议
- GRE: GRE协议
- ICMP: ICMP(IPv4)协议
Prioritystring

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

1
CidrIpstring

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

47.100.XX.XX/16
AuthorizeAccessPolicyRulearray

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

object

客户端IP白名单对象。

Descriptionstring

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

华北分公司
CidrIpstring

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

47.100.XX.XX/16
ClientTypearray

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

object

登录方式管控对象。

Statusstring

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

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

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

说明如果不设置ClientType相关参数,则默认允许所有类型的客户端登录云桌面。
windows
枚举值:
- html5: Web客户端
- android: Android客户端
- linux: 阿里云云终端
- ios: iOS客户端
- windows: Windows客户端
- macos: macOS客户端
GpuAccelerationstring

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

off
枚举值:
- off: 关闭
- on: 开启
UsbSupplyRedirectRulearray

USB重定向规则。

object

USB重定向规则。

VendorIdstring

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

04**
ProductIdstring

产品ID。

08**
Descriptionstring

规则描述。

测试规则
UsbRedirectTypelong

USB重定向类型。

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

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

0Eh
DeviceSubclassstring

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

xxh
UsbRuleTypelong

USB重定向规则类型。

1
枚举值:
- 1: 设备类别
- 2: 设备厂商
Recordingstring

是否开启录屏。

OFF
枚举值:
- ALLTIME: 全程录屏,从登录桌面开始到退出桌面。
- PERIOD: 间隔录屏,需设置录屏开始和结束时间。
- OFF: 不开启录屏。
RecordingStartTimestring

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

08:00:00
RecordingEndTimestring

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

08:59:00
RecordingFpslong

录屏帧数。

2
枚举值:
- 2: 2
- 5: 5
- 10: 10
- 15: 15
RecordingExpireslong

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

15
CameraRedirectstring

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

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

是否开启网络重定向。

off
枚举值:
- off: 关闭 [默认值]
- on: 开启
AppContentProtectionstring

是否开启防截屏功能。

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

是否开启自定义录屏。

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

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

30
RemoteCoordinatestring

远程协助时的键鼠控制权限。

fullControl
枚举值:
- optionalControl: 默认关闭(可以申请打开)
- fullControl: 完全控制
- disableControl: 不控制
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

返回参数

名称类型描述示例值
object

返回信息集合。

PolicyGroupIdstring

策略ID。

pg-gx2x1dhsmthe9****
RequestIdstring

请求ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-11-04OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:RecordingAudio
2022-10-08OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:RecordingDuration
2022-01-11OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Recording
    新增入参:RecordingStartTime
    新增入参:RecordingEndTime
    新增入参:RecordingFps
    新增入参:CameraRedirect
2021-11-30OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:GpuAcceleration
阿里云首页 无影云桌面 相关技术圈