创建策略。
接口说明
策略是一组安全规则的集合,可以控制终端用户使用云桌面的相关安全配置,包含 USB 重定向、水印等基础策略,以及安全组管控等规则。更多信息,请参见策略概述。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecd:CreatePolicyGroup | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
Clipboard | string | 否 | 剪贴板权限。 枚举值:
| off |
LocalDrive | string | 否 | 本地磁盘映射权限。 枚举值:
| off |
UsbRedirect | string | 否 | USB 重定向。 枚举值:
| off |
VisualQuality | string | 否 | 图像显示质量策略。 枚举值:
| medium |
Html5Access | string | 否 | HTML5 客户端访问策略。 说明
推荐您使用 ClientType 相关参数统一管控登录方式。
枚举值:
| off |
Html5FileTransfer | string | 否 | HTML5 客户端文件传输策略。 枚举值:
| off |
Watermark | string | 否 | 水印。 枚举值:
| off |
Name | string | 否 | 策略名称。 | testPolicyGroupName |
WatermarkType | string | 否 | 水印类型。支持同时选择多个类型,用英文逗号隔开。 枚举值:
| EndUserId |
WatermarkTransparency | string | 否 | 水印显示的深浅程度。 枚举值:
| LIGHT |
PreemptLogin | string | 否 | 桌面抢占策略。 说明
为保证正在使用云桌面的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占,即该配置默认为 off ,且不可修改。
枚举值:
| off |
DomainList | string | 否 | 访问域名权限管控。域名支持*通配符,多个域名之间以英文逗号隔开。取值范围:
| off |
PrinterRedirection | string | 否 | 打印机重定向策略。 枚举值:
| on |
PreemptLoginUser | array | 否 | 允许抢占桌面的一组用户的用户名,最多可以设置 5 个。 说明
为保证正在使用云桌面的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占。
| |
string | 否 | 可抢占桌面的用户的用户名。 | Alice | |
AuthorizeSecurityPolicyRule | object [] | 否 | 安全组管控规则数组。 | |
Type | string | 否 | 安全组管控规则的规则方向。 枚举值:
| inflow |
Policy | string | 否 | 安全组管控规则的授权策略。 枚举值:
| accept |
PortRange | string | 否 | 安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:
典型应用的常用端口请参见常用端口。 | 22/22 |
Description | string | 否 | 安全组管控规则的描述信息。 | test |
IpProtocol | string | 否 | 安全组管控规则的协议类型。 枚举值:
| tcp |
Priority | string | 否 | 安全组管控规则的优先级。数字越小,代表优先级越高。 | 1 |
CidrIp | string | 否 | 安全组管控规则的对象,CIDR 格式的 IPv4 地址段。 | 47.100.XX.XX/16 |
AuthorizeAccessPolicyRule | object [] | 否 | 客户端 IP 白名单数组。设置后,仅白名单网段内的 IP 地址可访问云桌面。 | |
Description | string | 否 | 客户端 IP 白名单的描述信息。 | 华北分公司 |
CidrIp | string | 否 | 客户端访问 IP 地址段。格式为 CIDR 格式的 IPv4 地址段。 | 47.100.XX.XX/16 |
ClientType | object [] | 否 | 登录方式管控数组。用于控制可通过哪些客户端访问云桌面。 | |
Status | string | 否 | 登录方式管控,设置是否允许使用某一类型的客户端登录云桌面。 说明
如果不设置 ClientType 相关参数,则默认允许所有类型的客户端登录云桌面。
枚举值:
| ON |
ClientType | string | 否 | 登录方式管控,设置客户端类型。 说明
如果不设置 ClientType 相关参数,则默认允许所有类型的客户端登录云桌面。
枚举值:
| windows |
GpuAcceleration | string | 否 | 是否为图形型规格云桌面开启画质策略。对桌面性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。 枚举值:
| off |
UsbSupplyRedirectRule | object [] | 否 | USB 重定向规则。 | |
VendorId | string | 否 | 生产厂商 ID。参见Valid USB Vendor IDs (VIDs)。 | 04** |
ProductId | string | 否 | 产品 ID。 | 08** |
Description | string | 否 | 规则描述。 | 测试规则 |
UsbRedirectType | long | 否 | USB 重定向类型。 枚举值:
| 1 |
DeviceClass | string | 否 | 设备类别,当 | 0Eh |
DeviceSubclass | string | 否 | 设备子类别,当 | xxh |
UsbRuleType | long | 否 | USB 重定向规则类型。 枚举值:
| 1 |
DomainResolveRuleType | string | 否 | 域名解析策略类型。 枚举值:
| OFF |
DomainResolveRule | object [] | 否 | 域名解析策略详情。 | |
Domain | string | 否 | 域名。 | *.baidu.com |
Policy | string | 否 | 策略类型。 枚举值:
| allow |
Description | string | 否 | 策略描述。 | 策略描述。 |
Recording | string | 否 | 是否开启录屏。 枚举值:
| OFF |
RecordingStartTime | string | 否 | 录屏开始时间,取值:HH:MM:SS。只有 Recording 取值是 PERIOD 时,该返回值有实际意义。 | 08:00:00 |
RecordingEndTime | string | 否 | 录屏结束时间,取值:HH:MM:SS。只有 Recording 取值是 PERIOD 时,该返回值有实际意义。 | 08:59:00 |
RecordingFps | long | 否 | 录屏帧数。 枚举值:
| 2 |
RecordingExpires | long | 否 | 录屏文件的过期时间,单位为天。 | 15 |
CameraRedirect | string | 否 | 是否开启本地摄像头重定向。 枚举值:
| on |
NetRedirect | string | 否 | 是否开启网络重定向。 说明
该功能处于定向邀测中,暂不对外开放。
枚举值:
| off |
AppContentProtection | string | 否 | 是否开启防截屏功能。 枚举值:
| off |
RecordContent | string | 否 | 是否开启自定义录屏。 枚举值:
| OFF |
RecordContentExpires | long | 否 | 自定义录屏的文件过期时间,默认 30 天。 | 30 |
RemoteCoordinate | string | 否 | 远程协助时的键鼠控制权限。 枚举值:
| fullControl |
RecordingDuration | integer | 否 | 与 Recording 配合使用,录屏指定时长后生成录屏文件。 | 15 |
Scope | string | 否 | 策略的生效范围。取值范围:
| GLOBAL |
ScopeValue | array | 否 | Scope 取值为 IP 的时候填写。 | |
string | 否 | 生效的 cidr block 范围。 | 47.100.XX.XX/24 | |
RecordingAudio | string | 否 | 录制桌面声音选项,取值范围:
| on |
InternetCommunicationProtocol | string | 否 | 网络通信协议。取值范围: -TCP:只允许使用 TCP。 -BOTH:允许自动在 TCP 和 UDP 之间切换。 默认值:TCP。 | both |
VideoRedirect | string | 否 | 多媒体重定向。取值范围:
| on |
WatermarkTransparencyValue | integer | 否 | 水印透明度,值越大,透明度越小。 取值范围: 10~100。 | 10 |
WatermarkColor | integer | 否 | 水印字体颜色。 取值范围: 0~16777215。 | 0 |
WatermarkDegree | double | 否 | 水印倾斜度。取值范围:-10~-30 。 | -10 |
WatermarkFontSize | integer | 否 | 水印字体大小。 取值范围:10~20。 | 10 |
WatermarkFontStyle | string | 否 | 水印字体样式, 取值范围:
| plain |
WatermarkRowAmount | integer | 否 | 水印行数,暂不生效。 | 5 |
EndUserApplyAdminCoordinate | string | 否 | 用户申请管理员协助开关,取值范围: ON:开启。 OFF:关闭。 | ON |
EndUserGroupCoordinate | string | 否 | 用户之间流协同开关,取值范围: ON:开启。 OFF:关闭。 | ON |
WatermarkSecurity | string | 否 | 盲水印安全优先规则,取值范围: on:开启。 off:关闭。 | on |
AdminAccess | string | 否 | 用户登录桌面后是否具有管理员权限 说明
该功能处于定向邀测中,暂不对外开放。
| deny |
WatermarkAntiCam | string | 否 | 盲水印防拍照功能,取值范围: on:开启。 off:关闭。 | off |
WatermarkPower | string | 否 | 盲水印增强功能,取值范围: low:低。 medium:中。 high:高。 | medium |
RecordingUserNotify | string | 否 | 录屏客户端消息通知功能,取值范围: on:开启。 off:关闭。 | off |
RecordingUserNotifyMessage | string | 否 | 录屏客户端通知内容。默认无需填写。 | 您的桌面正在被录屏 |
返回参数
示例
正常返回示例
JSON
格式
{
"PolicyGroupId": "pg-gx2x1dhsmthe9****",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-01-26 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2024-01-05 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-09-20 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-07-31 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-11-04 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-10-08 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-01-11 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2021-11-30 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|