获取集群策略

调试

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

请求参数

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

系统规定参数。取值:DescribeClusterPolicy

ClusterId String gws-xxx

集群 id

TaskId String t-xxx
说明 此值只在 AsyncModetrue 时有效

非空时用来获得之前查询命令的执行状态。

AsyncMode Boolean true

异步模式调用:

  • false(默认):命令执行完成后,api 才会返回
  • true:api 立即返回
    • TaskId 为空:查询命令在后台异步执行。调用方需使用返回值中的 TaskId,继续调用此 api 来获得查询命令的结果。
    • TaskId 不为空:获得查询命令的结果

返回数据

名称 类型 示例值 描述
Clipboard String readwrite

本地剪贴板在云桌面中:

  • off:关闭
  • read:只可读
  • write:只可写
  • readwrite:可读 & 可写
LocalDrive String readwrite

本地磁盘在云桌面中的映射驱动器:

  • off:关闭
  • read:只可读
  • readwrite:可读 & 可写
RequestId String XXX-XXX

Request Id

TaskFinished Boolean true
说明 此值只在 AsyncModetrue 时有效

当前查询命令的运行状态

  • false:还未完成。
  • true:已完成。
TaskId String t-xxx
说明 此值只在 AsyncModetrue 时有效

当前查询命令的任务 id。

UdpPort String on

UDP 端口:

  • on:打开
  • off:关闭
UsbRedirect String off

USB 重定向:

  • off
  • on
Watermark String off

水印:

  • off
  • on

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeClusterPolicy
&ClusterId=gws-xxx
&<公共请求参数>

正常返回示例

XML 格式

<TaskId>t-xxx</TaskId>
<RequestId>XXX-XXX</RequestId>
<UdpPort>on</UdpPort>
<LocalDrive>readwrite</LocalDrive>
<UsbRedirect>off</UsbRedirect>
<TaskFinished>true</TaskFinished>
<Clipboard>readwrite</Clipboard>
<Watermark>off</Watermark>

JSON 格式

{"TaskId":"t-xxx","RequestId":"XXX-XXX","UdpPort":"on","LocalDrive":"readwrite","UsbRedirect":"off","TaskFinished":"true","Clipboard":"readwrite","Watermark":"off"}

错误码

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