创建云电脑策略。
接口说明
云电脑策略是一组规则的集合,主要包含云电脑性能和安全方面的配置,例如磁盘映射、USB 重定向、水印等基础策略,以及 DNS 管控等规则。更多信息,请参见策略概述。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
Clipboard | string | 否 | 剪贴板权限。 枚举值:
| off |
LocalDrive | string | 否 | 本地磁盘映射权限。 枚举值:
| off |
UsbRedirect | string | 否 | USB 重定向。 枚举值:
| off |
VisualQuality | string | 否 | 图像显示质量策略。 枚举值:
| medium |
Html5Access | string | 否 | Web 客户端访问策略。 说明
推荐您使用 ClientType 相关参数统一管控登录方式。
枚举值:
| off |
Html5FileTransfer | string | 否 | Web 客户端文传输策略。 枚举值:
| off |
Watermark | string | 否 | 水印。 枚举值:
| off |
Name | string | 否 | 策略名称。 | testPolicyGroupName |
WatermarkType | string | 否 | 水印类型。最多可以选择 3 个类型,用半角逗号隔开。 说明
若传入 custom ,则必须同时通过参数WatermarkCustomText 传入自定义文本的内容。
枚举值:
| EndUserId |
WatermarkTransparency | string | 否 | 水印显示的深浅程度。 枚举值:
| LIGHT |
PreemptLogin | string | 否 | 云电脑抢占策略。 说明
为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占,即该配置默认为 off ,且不可修改。
枚举值:
| off |
DomainList | string | 否 | 访问域名权限管控。域名支持通配符(*),多个域名之间以半角逗号隔开。 枚举值:
| off |
PrinterRedirection | string | 否 | 打印机重定向策略。 枚举值:
| on |
PreemptLoginUser | array | 否 | 允许抢占云电脑的一组用户的用户名,最多可以设置 5 个。 说明
为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占。
| |
string | 否 | 可抢占云电脑的用户的用户名。 | Alice | |
AuthorizeSecurityPolicyRule | array<object> | 否 | 安全组管控规则列表。 | |
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 | array<object> | 否 | 客户端 IP 白名单列表。设置后,仅白名单网段内的 IP 地址可访问云电脑。 | |
object | 否 | 客户端 IP 白名单。 | ||
Description | string | 否 | 客户端 IP 白名单的描述信息。 | 华北分公司 |
CidrIp | string | 否 | 客户端访问 IP 地址段。格式为 CIDR 格式的 IPv4 地址段。 | 47.100.XX.XX/16 |
ClientType | array<object> | 否 | 登录方式管控规则列表。用于控制可通过哪些客户端访问云电脑。 | |
object | 否 | 登录方式管控规则。 | ||
Status | string | 否 | 登录方式管控,设置是否允许使用某一类型的客户端登录云电脑。 说明
如果不设置 ClientType 相关参数,则默认允许所有类型的客户端登录云电脑。
枚举值:
| ON |
ClientType | string | 否 | 登录方式管控,设置客户端类型。 说明
如果不设置 ClientType 相关参数,则默认允许所有类型的客户端登录云电脑。
枚举值:
| windows |
GpuAcceleration | string | 否 | 是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。 枚举值:
| off |
UsbSupplyRedirectRule | array<object> | 否 | USB 重定向规则。 | |
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 | array<object> | 否 | 域名解析策略详情。 | |
object | 否 | 域名解析策略。 | ||
Domain | string | 否 | 域名。 | *.example.com |
Policy | string | 否 | 解析策略。 枚举值:
| allow |
Description | string | 否 | 策略描述。 | 测试规则 |
Recording | string | 否 | 是否开启录屏。 枚举值:
| OFF |
RecordingStartTime | string | 否 | 录屏开始时间,取值:HH:MM:SS。只有 | 08:00:00 |
RecordingEndTime | string | 否 | 录屏结束时间,取值:HH:MM:SS。只有 | 08:59:00 |
RecordingFps | long | 否 | 录屏帧率。单位:FPS(帧/秒)。 枚举值:
| 2 |
RecordingExpires | long | 否 | 录屏文件的保留时间。取值范围为 1~180 天。 | 15 |
CameraRedirect | string | 否 | 是否开启本地摄像头重定向。 枚举值:
| on |
NetRedirect | string | 否 | 是否开启网络重定向。 说明
该功能处于定向邀测中,暂不对外开放。
枚举值:
| off |
AppContentProtection | string | 否 | 是否开启防截屏功能。 枚举值:
| off |
RecordContent | string | 否 | 是否开启自定义录屏。 枚举值:
| OFF |
RecordContentExpires | long | 否 | 自定义录屏的文件过期时间,默认 30 天。 | 30 |
RemoteCoordinate | string | 否 | 远程协助时的键鼠控制权限。 枚举值:
| fullControl |
RecordingDuration | integer | 否 | 录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到 300MB 时优先滚动更新。 枚举值:
| 10 |
Scope | string | 否 | 策略的生效范围。 枚举值:
| GLOBAL |
ScopeValue | array | 否 |
| |
string | 否 | 生效的 CIDR Block 范围。 | 47.100.XX.XX/24 | |
RecordingAudio | string | 否 | 录制云电脑声音的选项。 枚举值:
| on |
InternetCommunicationProtocol | string | 否 | 网络通信协议。 枚举值:
| 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 |
EndUserGroupCoordinate | string | 否 | 用户之间流协同开关。 枚举值:
| ON |
WatermarkSecurity | string | 否 | 盲水印安全优先规则。 枚举值:
| on |
AdminAccess | string | 否 | 用户登录云电脑后是否具有管理员权限。 说明
该功能处于定向邀测中,暂不对外开放。
| deny |
WatermarkAntiCam | string | 否 | 盲水印防拍照功能。 枚举值:
| off |
WatermarkPower | string | 否 | 盲水印增强功能。 枚举值:
| medium |
RecordingUserNotify | string | 否 | 录屏客户端消息通知功能。 枚举值:
| off |
RecordingUserNotifyMessage | string | 否 | 录屏客户端通知内容。默认无需填写。 | 您的云电脑正在被录屏 |
MaxReconnectTime | integer | 否 | 云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30~7200,单位:秒。 | 120 |
DeviceRedirects | array<object> | 否 | 设备重定向规则列表。 | |
object | 否 | 设备重定向规则。 | ||
DeviceType | string | 否 | 外设类型。 枚举值:
| camera |
RedirectType | string | 否 | 重定向类型。 枚举值:
| deviceRedirect |
DeviceRules | array<object> | 否 | 自定义外设规则列表。 | |
object | 否 | 自定义外设规则。 | ||
DeviceType | string | 否 | 外设类型。 枚举值:
| storage |
DeviceName | string | 否 | 设备名称。 | sandisk |
DeviceVid | string | 否 | 生产厂商 ID。参见Valid USB Vendor IDs (VIDs)。 | 0x0781 |
DevicePid | string | 否 | 产品 ID。 | 0x55b1 |
RedirectType | string | 否 | 重定向类型。 枚举值:
| usbRedirect |
OptCommand | string | 否 | 链接优化指令。 | 2:0 |
返回参数
示例
正常返回示例
JSON
格式
{
"PolicyGroupId": "pg-gx2x1dhsmthe9****",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-15 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-08-05 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-07-19 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-07-01 | OpenAPI 入参发生变更 | 查看变更详情 |
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 入参发生变更 | 查看变更详情 |