接口说明
开放政企版编辑电脑策略接口 限流:根据租户实现用户级别的限流,限制为100次每秒
URL
POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/computerPolicy/updatePolicy
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
reqDto
|
UpdateComputerPolicyReqDto
|
是
|
请求入参 |
|
policyId
|
string
|
是
|
策略id |
|
policyName
|
string
|
是
|
策略名称 |
|
policyRemark
|
string
|
否
|
策略描述 |
|
dc
|
string
|
否
|
网络工作区,V2.0协议非必传 |
|
poolCode
|
string
|
否
|
所属资源池 |
|
region
|
string
|
否
|
所属可用区 |
|
computerProtocol
|
string
|
否
|
电脑协议(V2.0:自研CMSSZTE,V1.1:新华三,V1.2:中兴) |
|
redirectLocalDiskScope
|
CemRedirectLocalDiskScope
|
否
|
本地磁盘映射作用范围 |
|
fixedDrive
|
string
|
否
|
固定驱动器(即本地系统除系统盘外其他磁盘)取值:禁用(disable)、启用(enable) |
|
networkDrive
|
string
|
否
|
网络驱动器 取值:禁用(disable)、启用(enable) |
|
opticalDiscDrive
|
string
|
否
|
光盘驱动器 取值:禁用(disable)、启用(enable) |
|
redirectLocalDisk
|
string
|
否
|
重定向本地磁盘, 禁用(disable)、只读(ro)、读写(rw) |
|
removableDrive
|
string
|
否
|
可移动驱动器 取值:禁用(disable)、启用(enable) |
|
terminalSystemDisk
|
string
|
否
|
终端系统磁盘(即本地系统盘,通常指C盘) 取值:禁用(disable)、启用(enable) |
|
redirectClipboard
|
string
|
否
|
重定向剪贴板,禁用(disable)、云端到本地(c2l), 本地到云端(l2c), 双向(both),默认both |
|
redirectUsbStorage
|
string
|
否
|
重定向USB存储,禁用(disable),读写(enable),只读(ro),默认enable |
|
redirectCamera
|
string
|
否
|
摄像头 关闭(disable)、可用(enable) 默认enable |
|
scannerEnable
|
string
|
否
|
是否开启USB扫描仪,禁用(disable)、可用(enable) |
|
networkScannerEnable
|
string
|
否
|
是否开启网络扫描仪,关闭(disable)、开启(enable), 默认关闭 |
|
printerEnable
|
string
|
否
|
是否开启打印机,禁用(disable)、可用(enable) |
|
networkPrinterEnable
|
string
|
否
|
是否开启网络打印机,禁用(disable)、可用(enable) |
|
redirectSerialport
|
string
|
否
|
串口 关闭(disable)、可用(enable) 默认 enable |
|
redirectParallelport
|
string
|
否
|
并口 关闭(disable)、可用(enable) 默认 enable |
|
redirectCustom
|
string
|
否
|
自定义USB重定向策略配置 关闭(disable)、可用(enable) 默认 disable |
|
exdPolicyExts
|
<CemExdPolicyDto> array
|
否
|
自定义USB重定向策略详情列表 |
|
classFilter
|
string
|
否
|
扫描仪(scanner),打印机(printer),存储设备(storage),摄像头(camera),智能卡(smartCard),无线设备(wireless),其他设备(other),全部(all) |
|
pidFilter
|
string
|
否
|
pid |
|
vidFilter
|
string
|
否
|
vid |
|
action
|
string
|
否
|
黑白名单:白名单(enable), 黑名单(disable) |
|
extRemark
|
string
|
否
|
备注 |
|
watermarkClass
|
WatermarkClass
|
否
|
水印详情 |
|
watermarkType
|
string
|
否
|
水印类型,明水印(0)、盲水印(1) 默认 明水印(0) |
|
watermarkEnable
|
string
|
否
|
是否开启水印,关闭(disable)、开启(enable) |
|
watermarkMachineIdEnable
|
string
|
否
|
是否显示云电脑ID |
|
watermarkMachineIpEnable
|
string
|
否
|
是否显示云电脑IP |
|
watermarkMachineMacEnable
|
string
|
否
|
是否显示云电脑mac |
|
watermarkTimeEnable
|
string
|
否
|
是否显示时间 |
|
watermarkCustomFieldEnable
|
string
|
否
|
是否显示自定义字段 |
|
watermarkCustomField
|
string
|
否
|
自定义字段 |
|
watermarkFont
|
string
|
否
|
字体, 幼圆:YouYuan, 宋体:SimSun, 楷体:KaiTi |
|
watermarkSize
|
integer(int32)
|
否
|
水印字体大小,单位px,范围<1-60> |
|
watermarkColor
|
string
|
否
|
水印字体颜色 #RRGGBB ,每个颜色用2个字节标识,范围<#000000-#ffffff> |
|
watermarkTransparency
|
integer(int32)
|
否
|
水印透明度,新华三中兴 (H3C、H3CEcloud)可设置值:50、100,自研和中兴(CMSSZTE、ZTE、ZTEEcloud)可设置值:1~100 0就是透明,100就是不透明 |
|
watermarkAngle
|
integer(int32)
|
否
|
水印倾斜度,枚举0,45 |
|
screenShotEnable
|
string
|
否
|
防截屏 禁用(disable)、可用(enable) 默认 enable |
|
autoLock
|
string
|
否
|
自动锁屏,单位分钟 默认锁屏时间 0 不锁屏 |
|
exdPolicyCustomWallpaperClass
|
CemExdPolicyCustomWallpaperClass
|
否
|
自定义电脑壁纸 |
|
customWallpaperAbsolutePath
|
string
|
否
|
自定义壁纸绝对路径 |
|
customWallpaperEnable
|
string
|
否
|
自定义壁纸开关 开启 enable 关闭 disable,默认 disable |
|
customWallpaperRelativePath
|
string
|
否
|
自定义壁纸相对路径 |
|
exdPolicyScreenRecordeClass
|
CemExdPolicyScreenRecordeClass
|
否
|
录屏管控 |
|
screenAuditPolicyUid
|
string
|
否
|
录屏审计策略表uid |
|
screenRecordEnable
|
string
|
否
|
录屏策略开关 取值 disable 、enable(默认) |
|
screenType
|
string
|
否
|
录屏类型 0:全程录屏 1: 间隔录屏(默认) 2:用户操作录屏 3:监听会话生命周期录屏 |
|
intervalRecordStartTime
|
string
|
否
|
间隔录屏开始时间 |
|
intervalRecordEndTime
|
string
|
否
|
间隔录屏结束时间 |
|
screenTriggerMode
|
string
|
否
|
用户操作录屏方式 1:云电脑与本地电脑进行文件双向上传、下载录屏 2:执行命令录屏 |
|
screenRecordMode
|
string
|
否
|
录制云电脑声音 1:仅录制画面不录制声音(默认) 2:音画同期录制 |
|
screenFPS
|
string
|
否
|
录屏图像帧率:单位fps 图像帧率:2 fps、5 fps(推荐)、10 fps和15 fps |
|
screenDuration
|
string
|
否
|
录屏文件阅览时长:单位分钟, 可选时长:10分钟(默认)、20分钟、30分钟、或60分钟 |
|
auditRetention
|
string
|
否
|
保留时长:单位天, 默认15天 保留时间的范围为:1~180天 |
|
terminalLoginPolicys
|
<DevicePolicyDetailReq> array
|
否
|
终端登录策略 |
|
category
|
enum(CLOSE_MACHINE,BAN_TERMINAL_TYPE,SHUT_SETTING,RESTART_SETTING,RECONNECT_INTERVAL,RECONNECT_TOTAL,CLOSE_DEVICE_SOURCE,DISCONNECT,START_MODE,UPDATE_MACHINE_NAME,ALLOW_RELOAD,BIGSCREEN_NET_CHECK,BIGSCREEN_ATTENTION,BIGSCREEN_SET,BIGSCREEN_MINIMIZE,BIGSCREEN_WINDOWED,BIGSCREEN_QUIT,BIGSCREEN_QUIT_BREAK,BIGSCREEN_QUIT_RESTART,BIGSCREEN_QUIT_SHUT,MOBILE_MANAGE,MOBILE_HELP,MOBILE_QUIT,MOBILE_QUIT_BREAK,MOBILE_QUIT_RESTART,MOBILE_QUIT_SHUT,CONNECT_TYPE,BREAK_SHUT)
|
否
|
终端登录枚举值 ALLOW_RELOAD 是否允许重装 CLOSE_MACHINE 关闭电脑电源(单位小时) BAN_TERMINAL_TYPE 禁止终端类型 SHUT_SETTING 关机设置 RESTART_SETTING 重启设置 RECONNECT_INTERVAL 客户端重连的时间间隙(单位/秒) RECONNECT_TOTAL 客户端重连的总时间(单位/秒) CLOSE_DEVICE_SOURCE 关闭终端电源 DISCONNECT 自动断开电脑连接 START_MODE 客户端启动模式 UPDATE_MACHINE_NAME 是否允许修改云电脑名称 |
|
value
|
string
|
否
|
终端登录value值 ALLOW_RELOAD 是否允许重装 0:开启 1:关闭 开启是允许在客户端执行重装操作,关闭则不允许在客户端执行重装操作 CLOSE_MACHINE 关闭电脑电源(单位小时) BAN_TERMINAL_TYPE 禁止终端类型 PC-WINDOWS:Windows版客户端 PC-MAC:MAC客户端 ANDROID-CE:Android瘦终端 MOBILE-ANDROID:Android客户端 MOBILE-IOS:IOS客户端 XC:信创客户端 XC-CE:信创瘦终端 SHUT_SETTING 关机设置 0:默认 1:仅云电脑关机 2:仅终端设备关机 3:云电脑和终端设备一起关机 RESTART_SETTING 重启设置 0:默认 1:仅云电脑重启 2:仅终端设备重启 3:云电脑和终端设备一起重启 RECONNECT_INTERVAL 客户端重连的时间间隙(单位/秒),1-50 RECONNECT_TOTAL 客户端重连的总时间(单位/秒)1-180 CLOSE_DEVICE_SOURCE 关闭终端电源(单位/分钟) 超过指定时间没操作电脑,则自动关闭终端电源,默认为0:从不关闭 DISCONNECT 自动断开电脑连接(单位/分钟) 超过以下时间没操作电脑,则自动断开桌面连接,默认为0,从不断开 START_MODE 客户端启动模式 json字符串type: 0:客户端优先,1:策略优先 mode:0:常规模式 , 1:锁定模式 macwhite:mac地址白名单,多个以,分割 {"type":"0","mode":"0","macwhite":""} UPDATE_MACHINE_NAME 是否允许修改云电脑名称 0:开启 1:关闭 开启时允许客户端修改云电脑名称,关闭则不允许修改云电脑名称,当用户修改时提示“该云电脑被禁止修改电脑名称,请联系管理员” |
|
desktopToolbarPolicys
|
<DevicePolicyDetailReq> array
|
否
|
桌面工具栏策略 |
|
category
|
enum(CLOSE_MACHINE,BAN_TERMINAL_TYPE,SHUT_SETTING,RESTART_SETTING,RECONNECT_INTERVAL,RECONNECT_TOTAL,CLOSE_DEVICE_SOURCE,DISCONNECT,START_MODE,UPDATE_MACHINE_NAME,ALLOW_RELOAD,BIGSCREEN_NET_CHECK,BIGSCREEN_ATTENTION,BIGSCREEN_SET,BIGSCREEN_MINIMIZE,BIGSCREEN_WINDOWED,BIGSCREEN_QUIT,BIGSCREEN_QUIT_BREAK,BIGSCREEN_QUIT_RESTART,BIGSCREEN_QUIT_SHUT,MOBILE_MANAGE,MOBILE_HELP,MOBILE_QUIT,MOBILE_QUIT_BREAK,MOBILE_QUIT_RESTART,MOBILE_QUIT_SHUT,CONNECT_TYPE,BREAK_SHUT)
|
否
|
桌面工具栏枚举值 BIGSCREEN_NET_CHECK 大屏客户端-网络检测 BIGSCREEN_ATTENTION 大屏客户端-帮助 BIGSCREEN_SET 大屏客户端-设置 BIGSCREEN_MINIMIZE 大屏客户端-最小化 BIGSCREEN_WINDOWED 大屏客户端-窗口化 BIGSCREEN_QUIT 大屏客户端-退出 BIGSCREEN_QUIT_BREAK 大屏客户端-退出-断开 BIGSCREEN_QUIT_RESTART 大屏客户端-退出-重启 BIGSCREEN_QUIT_SHUT 大屏客户端-退出-关机 MOBILE_MANAGE 移动客户端-管理 MOBILE_HELP 移动客户端-帮助 MOBILE_QUIT 移动客户端-退出 MOBILE_QUIT_BREAK 移动客户端-退出-断开 MOBILE_QUIT_RESTART 移动客户端-退出-重启 MOBILE_QUIT_SHUT 移动客户端-退出-关机 |
|
value
|
string
|
否
|
桌面工具栏value值 BIGSCREEN_NET_CHECK 大屏客户端-网络检测 0:开启 1:关闭,默认开启 BIGSCREEN_ATTENTION 大屏客户端-帮助 0:开启 1:关闭,默认开启 BIGSCREEN_SET 大屏客户端-设置 0:开启 1:关闭,默认开启 BIGSCREEN_MINIMIZE 大屏客户端-最小化 0:开启 1:关闭,默认开启 BIGSCREEN_WINDOWED 大屏客户端-窗口化 0:开启 1:关闭,默认开启 BIGSCREEN_QUIT 大屏客户端-退出 0:开启 1:关闭 ,新策略创建时默认为开启、可修改为关闭,退出和子功能(断开、重启、关机)是两个层级,有联动效果:当开启时展示子功能(断开、重启、关机)、关闭则不展示子功能(即退出关闭时子功能全部为关闭)。当退出的全部子功能均为关闭时,退出自动设置为关闭 BIGSCREEN_QUIT_BREAK 大屏客户端-退出-断开 0:开启 1:关闭,默认开启 BIGSCREEN_QUIT_RESTART 大屏客户端-退出-重启 0:开启 1:关闭,默认开启 BIGSCREEN_QUIT_SHUT 大屏客户端-退出-关机 0:开启 1:关闭,默认开启 MOBILE_MANAGE 移动客户端-管理 0:开启 1:关闭,默认开启 MOBILE_HELP 移动客户端-帮助 0:开启 1:关闭,默认开启 MOBILE_QUIT 移动客户端-退出 0:开启 1:关闭 新策略创建时默认为开启、可修改为关闭,退出和子功能(断开、重启、关机)是两个层级,有联动效果:当开启时展示子功能(断开、重启、关机)、关闭则不展示子功能(即退出关闭时子功能全部为关闭)。当退出的全部子功能均为关闭时,退出自动设置为关闭 MOBILE_QUIT_BREAK 移动客户端-退出-断开 0:开启 1:关闭,默认开启 MOBILE_QUIT_RESTART 移动客户端-退出-重启 0:开启 1:关闭,默认开启 MOBILE_QUIT_SHUT 移动客户端-退出-关机 0:开启 1:关闭,默认开启 |
|
networkPolicys
|
<DevicePolicyDetailReq> array
|
否
|
网络控制 |
|
category
|
enum(CLOSE_MACHINE,BAN_TERMINAL_TYPE,SHUT_SETTING,RESTART_SETTING,RECONNECT_INTERVAL,RECONNECT_TOTAL,CLOSE_DEVICE_SOURCE,DISCONNECT,START_MODE,UPDATE_MACHINE_NAME,ALLOW_RELOAD,BIGSCREEN_NET_CHECK,BIGSCREEN_ATTENTION,BIGSCREEN_SET,BIGSCREEN_MINIMIZE,BIGSCREEN_WINDOWED,BIGSCREEN_QUIT,BIGSCREEN_QUIT_BREAK,BIGSCREEN_QUIT_RESTART,BIGSCREEN_QUIT_SHUT,MOBILE_MANAGE,MOBILE_HELP,MOBILE_QUIT,MOBILE_QUIT_BREAK,MOBILE_QUIT_RESTART,MOBILE_QUIT_SHUT,CONNECT_TYPE,BREAK_SHUT)
|
否
|
网络控制枚举值 CONNECT_TYPE 接入网络控制 |
|
value
|
string
|
否
|
网络控制value值 CONNECT_TYPE 接入网络控制(0-不限,1-仅限公网,2-仅限专线) |
|
bandwidthLimitEnable
|
string
|
否
|
带宽是否启用 关闭(disable)、可用(enable) 默认 disable |
|
usbBandwidth
|
integer(int32)
|
否
|
usb带宽范围, 500 - 2000 KB , 默认 500 KB, 增减步长 500, 单位(KB) |
|
diskBandwidth
|
integer(int32)
|
否
|
磁盘映射范围, 500 - 2000 KB , 默认 500 KB, 增减步长 500, 单位(KB) |
|
clipboardBandwidth
|
integer(int32)
|
否
|
文件拷贝带宽控制-剪贴板范围, 500 - 2000 KB , 默认 500 KB, 增减步长 500, 单位(KB) |
|
securityGroupUid
|
string
|
否
|
安全组UID |
|
qosUid
|
string
|
否
|
Qos规则的UID |
|
streamingVideo
|
integer(int32)
|
否
|
图流设置 默认 2 最小值1 最大值2 |
|
desktopStreamRat
|
integer(int32)
|
否
|
图像上限帧率 默认30 最小值12 最大值100 |
|
autoDesktopQuality
|
integer(int32)
|
否
|
图像画质 默认 2 最小值0 最大值3 |
|
audioPlayBackModeEnable
|
string
|
否
|
音频播放模式是否开启, 禁用(disable)、开启(enable) , 默认 关闭 disable |
|
audioPlayBackMode
|
string
|
否
|
音频播放模式, 1:默认模式 2:极速模式/加速模式 3:流畅模式 |
|
exdCloudSideNetRedirectClass
|
ExdCloudSideNetRedirectClass
|
否
|
云侧网络重定向 |
|
netRedirectEnable
|
string
|
否
|
网络重定向开关: 类非空情况下必填 关闭(disable)、开启(enable) |
|
netRedirectMode
|
string
|
否
|
重定向模式: 开关开启状态下必填, 白名单模式:whitelistMode 全局模式:globalMode |
|
whitelistConfigs
|
<WhitelistConfigClass> array
|
否
|
白名单类型: 白名单模式下配置 |
|
whitelistType
|
string
|
否
|
白名单类型: 白名单模式下必填, 域名:domainName 进程:process |
|
whitelistRule
|
string
|
否
|
白名单规则: 白名单模式下必填 |
请求示例
POST https://ecloud.10086.cn/api/Computer_api/cem_openapi/ccacem/api/v1/computerPolicy/updatePolicy
{
"policyName":"openapi测试",
"computerProtocol":"V2.0",
"poolCode":"CIDC-RP-25",
"region":"CIDC-RP-25-AZ2",
"policyId":"23a45b14-c7b9-4305-a157-85d918d24f24",
"dc":"VMC151-new",
"redirectClipboard":"both",
"redirectLocalDiskScope":{
"redirectLocalDisk":"rw"
},
"screenShotEnable":"enable",
"watermarkClass":{
"watermarkEnable":"enable",
"watermarkType":"0",
"watermarkMachineIdEnable":"enable",
"watermarkMachineIpEnable":"enable",
"watermarkMachineMacEnable":"disable",
"watermarkTimeEnable":"disable",
"watermarkCustomFieldEnable":"disable",
"watermarkSize":12,
"watermarkColor":"#000000",
"watermarkTransparency":50,
"watermarkAngle":0,
"watermarkFont":"SimSun"
},
"autoLock":"0",
"exdPolicyCustomWallpaperClass":{
"customWallpaperEnable":"disable"
},
"redirectUsbStorage":"enable",
"redirectCamera":"enable",
"networkScannerEnable":"disable",
"redirectSerialport":"enable",
"redirectParallelport":"enable",
"redirectCustom":"enable",
"exdPolicyExts":[
{
"classFilter":"all",
"vidFilter":"1234",
"pidFilter":"4563",
"extRemark":"",
"action":"enable"
}
],
"terminalLoginPolicys":[
{
"category":"RECONNECT_INTERVAL",
"value":5
},
{
"category":"RECONNECT_TOTAL",
"value":30
},
{
"category":"CLOSE_DEVICE_SOURCE",
"value":"0"
},
{
"category":"DISCONNECT",
"value":"0"
},
{
"category":"START_MODE",
"value":"{\"type\":\"0\",\"mode\":\"\",\"macwhite\":\"\"}"
},
{
"category":"UPDATE_MACHINE_NAME",
"value":"0"
},
{
"category":"ALLOW_RELOAD",
"value":"0"
},
{
"category":"BAN_TERMINAL_TYPE",
"value":"PC-WINDOWS,ANDROID-CE,PC-MAC"
},
{
"category":"SHUT_SETTING",
"value":"0"
},
{
"category":"RESTART_SETTING",
"value":"0"
}
],
"desktopToolbarPolicys":[
{
"category":"BIGSCREEN_NET_CHECK",
"value":"0"
},
{
"category":"BIGSCREEN_ATTENTION",
"value":"0"
},
{
"category":"BIGSCREEN_SET",
"value":"0"
},
{
"category":"BIGSCREEN_MINIMIZE",
"value":"0"
},
{
"category":"BIGSCREEN_WINDOWED",
"value":"0"
},
{
"category":"BIGSCREEN_QUIT",
"value":"0"
},
{
"category":"BIGSCREEN_QUIT_BREAK",
"value":"0"
},
{
"category":"BIGSCREEN_QUIT_RESTART",
"value":"0"
},
{
"category":"BIGSCREEN_QUIT_SHUT",
"value":"0"
},
{
"category":"MOBILE_MANAGE",
"value":"0"
},
{
"category":"MOBILE_HELP",
"value":"0"
},
{
"category":"MOBILE_QUIT",
"value":"0"
},
{
"category":"MOBILE_QUIT_BREAK",
"value":"0"
},
{
"category":"MOBILE_QUIT_RESTART",
"value":"0"
},
{
"category":"MOBILE_QUIT_SHUT",
"value":"0"
}
],
"networkPolicys":[
{
"category":"CONNECT_TYPE",
"value":"0"
}
],
"securityGroupUid":"sg-a551ec2f9c3a4c5db970aaa05c4f47d4",
"bandwidthLimitEnable":"enable",
"usbBandwidth":7000,
"diskBandwidth":9000,
"clipboardBandwidth":8000,
"streamingVideo":2,
"desktopStreamRat":30,
"autoDesktopQuality":2,
"audioPlayBackModeEnable":"enable",
"audioPlayBackMode":"2",
"exdCloudSideNetRedirectClass":{
"netRedirectEnable":"enable",
"netRedirectMode":"whitelistMode",
"whitelistConfigs":[
{
"whitelistType":"domainName",
"whitelistRule":"cmss.example.com"
}
]
}
}
返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
boolean
|
请求成功时返回的数据 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
错误码提示信息 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,FORBIDDEN,REMAINING,TIMEOUT)
|
返回状态码;返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN |
返回示例
{
"state":"OK",
"body":true,
"errorCode":"200",
"errorMessage":"",
"requestId":"78c09025e7c33cce"
}