文档

DescribeGWSClusterPolicy - 查看可是化服务的策略配置信息

更新时间:

调用DescribeGWSClusterPolicy查看可视化服务的配置信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClusterIdstring

可视化服务集群 ID。

gws-rhz99q8rc****
TaskIdstring

任务 ID。只有 AsyncMode 取值为 true 时有效,您可以通过调用 DescribeClusterConnections 接口查询任务的执行状态。

t-****
AsyncModeboolean

是否支持异步调用模式:

  • false:不支持,当本次请求调用完成后,才返回结果。
  • true:支持,无需等待本次请求调用完成,立即返回结果。

默认值:false

true

返回参数

名称类型描述示例值
object
Watermarkstring

水印。可能值:

  • on:开启
  • off:关闭
on
Clipboardstring

剪贴板权限。可能值:

  • read:只读。可以将本地内容复制到云桌面,不能将云桌面内容复制到本地。
  • readwrite:读写。可以将本地内容复制到云桌面,也可以将云桌面内容复制到本地。
  • off:关闭。云桌面和本地之间无法进行复制操作。
read
RequestIdstring

请求 ID。

7afc5a17-e60d-4a2a-85d6-7c9d4a81d65e
UsbRedirectstring

USB 重定向。可能值:

  • on:开启
  • off:关闭
on
LocalDrivestring

本地磁盘映射权限。可能值:

  • read:只读。云桌面上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件。
  • readwrite:读写。云桌面上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件。
  • off:关闭。云桌面上没有本地磁盘的映射。
off

示例

正常返回示例

JSON格式

{
  "Watermark": "on",
  "Clipboard": "read",
  "RequestId": "7afc5a17-e60d-4a2a-85d6-7c9d4a81d65e",
  "UsbRedirect": "on",
  "LocalDrive": "off"
}

JSON格式

{
  "Watermark": "on",
  "Clipboard": "read",
  "RequestId": "7afc5a17-e60d-4a2a-85d6-7c9d4a81d65e",
  "UsbRedirect": "on",
  "LocalDrive": "off"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsInvalid param: %s-
406AliyunError其他云产品接口请求失败
407NotAuthorized此请求未获得RAM授权
500UnknownError未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

  • 本页导读 (1)
文档反馈