CreatePolicyGroup - 创建云电脑策略

更新时间:
复制 MD 格式

创建云电脑策略。

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:CreatePolicyGroup

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

Clipboard

string

剪贴板权限。

枚举值:

  • read :

    单向允许。可以将本地内容复制到云电脑,不能将云电脑内容复制到本地

  • readwrite :

    双向允许。可以将本地内容复制到云电脑,也可以将云电脑内容复制到本地

  • write :

    单向允许。可以将云电脑内容复制到本地,不能将本地内容复制到云电脑

  • off :

    双向禁止。云电脑和本地之间无法进行复制操作 [默认值]

off

LocalDrive

string

本地磁盘映射权限。

枚举值:

  • read :

    只读。云电脑上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件

  • readwrite :

    读写。云电脑上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件

  • off :

    关闭。云电脑上没有本地磁盘的映射 [默认值]

off

UsbRedirect

string

USB 重定向。

枚举值:

  • off :

    关闭 [默认值]

  • on :

    开启

off

VisualQuality

string

图像显示质量策略。

枚举值:

  • high :

    高清

  • low :

    流畅

  • lossless :

    无损

  • medium :

    自适应 [默认值]

medium

Html5Access

string

Web 客户端访问策略。

说明

推荐您使用ClientType相关参数统一管控登录方式。

枚举值:

  • off :

    禁止 [默认值]

  • on :

    允许

off

Html5FileTransfer

string

Web 客户端文传输策略。

枚举值:

  • all :

    允许上传下载

  • download :

    允许下载

  • upload :

    允许上传

  • off :

    关闭 [默认值]

off

Watermark

string

水印。

枚举值:

  • blind :

    开启盲水印

  • off :

    关闭水印 [默认值]

  • on :

    开启明水印

off

Name

string

策略名称。

testPolicyGroupName

WatermarkType

string

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

说明

若传入custom,则必须同时通过参数WatermarkCustomText传入自定义文本的内容。

枚举值:

  • EndUserId :

    用户名

  • Custom :

    自定义文本

  • DesktopIp :

    云电脑 IP 地址

  • ClientIp :

    客户端 IP 地址

  • HostName :

    云电脑 ID 的后 15 位

  • ClientTime :

    云电脑当前时间

EndUserId

WatermarkTransparency

string

水印显示的深浅程度。

枚举值:

  • LIGHT :

    较浅 [默认值]

  • DARK :

    较深

  • MIDDLE :

    普通

LIGHT

PreemptLogin

string

云电脑抢占策略。

说明

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

枚举值:

  • off :

    不允许多个用户之间互相抢占 [默认值]

off

DomainList

string

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

枚举值:

  • off :

    关闭

  • on :

    开启

off

PrinterRedirection

string

打印机重定向策略。

枚举值:

  • off :

    关闭

  • on :

    打开

on

PreemptLoginUser

array

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

说明

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

Alice

string

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

Alice

AuthorizeSecurityPolicyRule

array<object>

安全组管控规则列表。

object

安全组管控规则。

Type

string

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

枚举值:

  • outflow :

    出方向

  • inflow :

    入方向

inflow

Policy

string

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

枚举值:

  • drop :

    拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接

  • accept :

    允许策略,接收所有访问请求 [默认值]

accept

PortRange

string

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

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

  • ICMP 协议:端口为-1/-1。

  • GRE 协议:端口为-1/-1。

  • IpProtocol 取值为 all:端口为-1/-1。

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

22/22

Description

string

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

允许访问内网研发环境

IpProtocol

string

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

枚举值:

  • TCP :

    TCP 协议

  • UDP :

    UDP 协议

  • ALL :

    支持所有协议

  • GRE :

    GRE 协议

  • ICMP :

    ICMP(IPv4)协议

tcp

Priority

string

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




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相关参数,则默认允许所有类型的客户端登录云电脑。

枚举值:

  • OFF :

    不允许

  • ON :

    允许

ON

ClientType

string

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

说明

如果不设置ClientType相关参数,则默认允许所有类型的客户端登录云电脑。

枚举值:

  • html5 :

    Web 客户端

  • android :

    Android 客户端

  • ios :

    iOS 客户端

  • windows :

    Windows 客户端

  • macos :

    macOS 客户端

windows

GpuAcceleration

string

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

枚举值:

  • off :

    关闭

  • on :

    开启

off

UsbSupplyRedirectRule

array<object>

USB 重定向规则。

object

USB 重定向规则。

VendorId

string

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

04**

ProductId

string

产品 ID。

08**

Description

string

规则描述。

测试规则

UsbRedirectType

integer

USB 重定向类型。

枚举值:

  • 1 :

    允许

  • 2 :

    拒绝

1

DeviceClass

string

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

0Eh

DeviceSubclass

string

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

xxh

UsbRuleType

integer

USB 重定向规则类型。

枚举值:

  • 1 :

    设备类别

  • 2 :

    设备厂商

1

DomainResolveRuleType

string

域名解析策略类型。

枚举值:

  • OFF :

    关闭

  • ON :

    开启

OFF

DomainResolveRule

array<object>

域名解析策略详情。

object

域名解析策略。

Domain

string

域名。

*.example.com

Policy

string

解析策略。

枚举值:

  • allow :

    允许

  • block :

    拒绝

allow

Description

string

策略描述。

测试规则

Recording

string

是否开启录屏。

枚举值:

  • byaction_cmd_ft :

    用户操作录屏(执行命令和传输文件时均触发)

  • ALLTIME :

    全程录屏,从连接云电脑开始到断开云电脑连接

  • session :

    监听会话生命周期录屏

  • PERIOD :

    间隔录屏,需设置录屏开始和结束时间

  • byaction_commands :

    用户操作录屏(仅执行命令时触发)

  • OFF :

    不开启录屏

  • byaction_file_transfer :

    用户操作录屏(仅传输文件时触发)

OFF

RecordingStartTime

string

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

08:00:00

RecordingEndTime

string

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

08:59:00

RecordingFps

integer

录屏帧率。单位:FPS(帧/秒)。

枚举值:

  • 2 :

    2

  • 5 :

    5

  • 10 :

    10

  • 15 :

    15

2

RecordingExpires

integer

录屏文件的保留时间。取值范围为 1~180 天。

15

CameraRedirect

string

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

枚举值:

  • off :

    关闭

  • on :

    开启 [默认值]

on

NetRedirect

string

是否开启网络重定向。

说明

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

枚举值:

  • off :

    关闭 [默认值]

  • on :

    开启

off

AppContentProtection

string

是否开启防截屏功能。

枚举值:

  • off :

    关闭 [默认值]

  • on :

    开启

off

RecordContent

string

是否开启自定义录屏。

枚举值:

  • off :

    关闭 [默认值]

  • on :

    开启

OFF

RecordContentExpires

integer

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

30

RemoteCoordinate

string

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

枚举值:

  • optionalControl :

    默认关闭(可以申请打开)

  • fullControl :

    完全控制

  • disableControl :

    不控制

fullControl

RecordingDuration

integer

录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到 300MB 时优先滚动更新。

枚举值:

  • 10 :

    10

  • 20 :

    20

  • 30 :

    30

  • 60 :

    60

10

Scope

string

策略的生效范围。

枚举值:

  • IP :

    根据 IP 生效

  • GLOBAL :

    全局生效

GLOBAL

ScopeValue

array

Scope取值为IP的时候填写。当ScopeIP时生效,否则不生效。

string

生效的 CIDR Block 范围。

47.100.XX.XX/24

RecordingAudio

string

录制云电脑声音的选项。

枚举值:

  • off :

    仅录制画面不录制声音

  • on :

    音画同期录制

on

InternetCommunicationProtocol

string

网络通信协议。

枚举值:

  • TCP :

    只允许使用 TCP [默认值]

  • BOTH :

    允许自动在 TCP 和 UDP 之间切换

both

VideoRedirect

string

多媒体重定向。

枚举值:

  • off :

    关闭媒体重定向

  • on :

    打开媒体重定向

on

WatermarkTransparencyValue

integer

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

10

WatermarkColor

integer

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

0

WatermarkDegree

number

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

-10

WatermarkFontSize

integer

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

10

WatermarkFontStyle

string

水印字体样式。

枚举值:

  • plain :

    普通

  • bold :

    加粗

plain

WatermarkRowAmount

integer

水印行数。

说明

此参数暂未开放使用。

5

EndUserApplyAdminCoordinate

string

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

枚举值:

  • OFF :

    关闭

  • ON :

    开启

ON

EndUserGroupCoordinate

string

用户之间流协同开关。

枚举值:

  • OFF :

    关闭

  • ON :

    开启

ON

WatermarkSecurity

string

盲水印安全优先规则。

枚举值:

  • off :

    关闭

  • on :

    开启

on

AdminAccess

string

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

说明

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

deny

WatermarkAntiCam

string

盲水印防拍照功能。

枚举值:

  • off :

    关闭

  • on :

    开启

off

WatermarkPower

string

盲水印增强功能。

枚举值:

  • high :

  • low :

  • medium :

medium

RecordingUserNotify

string

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

枚举值:

  • off :

    关闭

  • on :

    开启

off

RecordingUserNotifyMessage

string

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

您的云电脑正在被录屏

MaxReconnectTime

integer

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

120

DeviceRedirects

array<object>

设备重定向规则列表。

object

设备重定向规则。

DeviceType

string

外设类型。

枚举值:

  • printer :

    打印机

  • scanner :

    扫描仪

  • camera :

    摄像头

  • adb :

    Android 设备

camera

RedirectType

string

重定向类型。

枚举值:

  • deviceRedirect :

    设备重定向

  • usbRedirect :

    USB 重定向

  • off :

    关闭重定向

deviceRedirect

DeviceRules

array<object>

自定义外设规则列表。

object

自定义外设规则。

DeviceType

string

外设类型。

枚举值:

  • usbKey :

    UKey

  • other :

    其他

  • graphicsTablet :

    手绘板

  • printer :

    打印机

  • cardReader :

    读卡器

  • scanner :

    扫描仪

  • storage :

    存储设备

  • camera :

    摄像头

  • adb :

    Android 设备

  • networkInterfaceCard :

    网卡设备

storage

DeviceName

string

设备名称。

sandisk

DeviceVid

string

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

0x0781

DevicePid

string

产品 ID。

0x55b1

RedirectType

string

重定向类型。

枚举值:

  • deviceRedirect :

    设备重定向

  • usbRedirect :

    USB 重定向

  • off :

    关闭重定向

usbRedirect

OptCommand

string

链接优化指令。

2:0

Platforms

string

设备规则适用的平台类型。

Windows

WyAssistant

string

通过桌面端(包括 Windows 客户端和 macOS 客户端)连接云电脑时,是否在云电脑悬浮球内提供无影 AI 助手功能入口。

说明

仅适用于 V7.7 或更高版本的桌面端。

枚举值:

  • off :

    不提供

  • on :

    提供

on

返回参数

名称

类型

描述

示例值

object

返回信息集合。

PolicyGroupId

string

云电脑策略 ID。

pg-gx2x1dhsmthe9****

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情