设置屏幕安全策略v3
更新时间 2026-11-09 15:01:41
最近更新时间: 2026-11-09 15:01:41
接口功能介绍
设置桌面防截屏和桌面水印配置。
接口约束
无
URI
POST /v3/strategy/screenSecurity
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| strategyOid | 是 | String | 策略Oid。 | ||
| screenshotProtectionEnable | 是 | Boolean | 是否启用桌面防截屏。 | ||
| desktopWatermark | 是 | Object | 桌面水印配置： - enable为false时， 不得提交其他水印字段。 - enable为true时， watermarkType必填。 - 类型为INVISIBLE时， 不得提交可见水印参数。 - watermarkType为VISIBLE时， 必须提交以下字段。 screenshotWatermarkEnable visibleWatermark | desktopWatermark |
表 desktopWatermark
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| enable | 是 | Boolean | 是否启用桌面水印。 | ||
| watermarkType | 否 | String | 水印类型。取值： - VISIBLE：可见水印。 - INVISIBLE：不可见水印。 | ||
| screenshotWatermarkEnable | 否 | Boolean | 截图是否叠加可见水印。 仅VISIBLE类型可提交，且必填。 | ||
| tenantLogoToken | 否 | String | 桌面水印企业Logo Token。 需要变更时，以上传策略图片v3接口返回值作为入参。 无需变更时，回传查询屏幕安全策略v3接口返回的同名字段。 可为null，缺失或为null表示清除Logo。 | ||
| visibleWatermark | 否 | Object | 可见水印配置。 仅VISIBLE类型可提交，且必填。 | visibleWatermark |
表 visibleWatermark
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| customContent | 是 | String | 自定义水印内容。 最多2行。 每行最多25个字符。 总计最多50个字符。 | ||
| dynamicContents | 是 | Array of Strings | 动态水印内容，不得重复。 取值： - TENANT_NAME：租户名。 - USER_NAME：用户名。 - DESKTOP_IP：云电脑IP。 - DESKTOP_MAC：云电脑MAC。 - SYSTEM_TIME：系统时间。 - USER_ACCOUNT：用户账号。 - USER_EMAIL：用户邮箱。 - USER_PHONE：用户手机。 | ||
| style | 是 | Object | DEFAULT模式不得提交 自定义样式字段。 CUSTOM模式必须提交 全部自定义样式字段。 | style |
表 style
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| mode | 是 | String | 水印样式模式。取值： - DEFAULT：默认样式。 - CUSTOM：自定义样式。 | ||
| fontSizePx | 否 | Integer | 字体大小，单位px。 取值10~50。 CUSTOM模式必填。 | ||
| bold | 否 | Boolean | 是否加粗；CUSTOM模式必填。 | ||
| fontColor | 否 | String | 字体颜色。 格式为#RRGGBB。 CUSTOM模式必填。 | ||
| opacityPercent | 否 | Integer | 不透明度百分比。 取值0~100。 0表示完全透明。 100表示完全不透明。 CUSTOM模式必填。 | ||
| inclinationDegrees | 否 | Integer | 倾斜角度，单位度。 取值：0、30、45、60、 -30、-45、-60。 CUSTOM模式必填。 | ||
| density | 否 | String | 水印密度。取值： - DENSE：密集。 - MEDIUM：中等。 - SPARSE：稀疏。 CUSTOM模式必填。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，800表示请求成功，900表示请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Boolean | 是否设置成功。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
请求头header
无
请求体body
{
"strategyOid":"dsy-xxxxxx",
"screenshotProtectionEnable":true,
"desktopWatermark":{
"enable":true,
"watermarkType":"VISIBLE",
"screenshotWatermarkEnable":true,
"tenantLogoToken":"xxx",
"visibleWatermark":{
"customContent":"内部资料",
"dynamicContents":["TENANT_NAME","USER_NAME","SYSTEM_TIME"],
"style":{
"mode":"CUSTOM",
"fontSizePx":20,
"bold":false,
"fontColor":"#FFFFFF",
"opacityPercent":30,
"inclinationDegrees":-30,
"density":"MEDIUM"
}
}
}
}
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":true
}
状态码
请参考 状态码
错误码
请参考 错误码
