设置集群策略

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SetClusterPolicy

系统规定参数。取值：SetClusterPolicy。
Clipboard String 是 read

剪贴板：

  • off：关闭
  • read：只可读
  • write：只可写
  • readwrite：可读写
ClusterId String 是 gws-xxx

集群 id
LocalDrive String 是 readwrite

本地磁盘映射：

  • off：关闭
  • read：只可读
  • readwrite：可读写
UsbRedirect String 是 on

USB 重定向：

  • off：关闭
  • on：打开
Watermark String 是 off

水印：

  • off：关闭
  • on：打开。水印为星状覆盖屏幕的两行半透明文字，格式为集群信息与主机信息，类似
    • gws-xxx@gws
    • c0-i00-xx-t6
UdpPort String 否 off

udp 端口：

  • on（默认）：打开。推荐配置为 on，带宽占用与网络稳定性更好。
  • off：关闭。定位 udp 相关的网络问题时，有时需要在这里设置 off，设置后安全组入方向的 1494 / 2598 的规则会被移除
Audio String 否 on

音频：

  • on（默认）：打开，客户端可以听到云桌面内部的声音。
  • off：关闭，客户端听不到云桌面内部的声音。
DomainList String 否 *.abc.com,*.xyz.com

域名白名单

  • 白名单为空时，允许访问所有域名
  • 白名单非空时，仅允许访问列表中的域名
  • 支持 * 通配符
  • 多条域名规则之间用逗号分隔
  • 设置后对当前集群的所有实例即时生效
AsyncMode Boolean 否 false

异步模式调用：

  • false（默认）：命令执行完成后，api 才会返回
  • true：命令后台执行，api 立即返回。调用方需要记录返回值中的 TaskId，然后来 DescribeClusterPolicy 查询命令的执行状态。

返回数据

名称 类型 示例值 描述
RequestId String XXXX

请求 id
TaskId String t-xxx
说明 此值只在 AsyncMode 为 true 时有效

调用方可使用此值，用 DescribeClusterPolicy 来查询命令的执行状态。

示例

请求示例

http(s)://[Endpoint]/?Action=SetClusterPolicy
&Clipboard=read
&ClusterId=gws-xxx
&LocalDrive=readwrite
&UsbRedirect=on
&Watermark=off
&<公共请求参数>

正常返回示例

XML 格式 

<TaskId>t-xxx</TaskId>
<RequestId>XXXX</RequestId>

JSON 格式 

{
    "TaskId": "t-xxx",
    "RequestId": "XXXX"
}

错误码

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