配置控制策略的RDP选项、SSH选项以及SFTP选项。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-bastionhost:SetPolicyProtocolConfig |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 堡垒机的实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。
| bastionhost-cn-st220aw**** |
RegionId | string | 否 | 堡垒机的区域 ID。 说明
区域 ID 和区域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
PolicyId | string | 是 | 指定要修改的控制策略的 ID。 说明
您可以调用 ListPolicies 接口获取该参数。
| 61 |
ProtocolConfig | object | 是 | 协议控制配置。 | |
RDP | object | 否 | RDP 选项配置详情。 | |
RecordKeyboard | string | 否 | 键盘记录配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
DiskRedirection | string | 否 | 驱动器/打印机映射配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
ClipboardDownload | string | 否 | 粘贴板下载配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
ClipboardUpload | string | 否 | 粘贴板上传配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SSH | object | 否 | SSH 和 SFTP 选项配置详情。 | |
X11Forwarding | string | 否 | X11 转发配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SFTPChannel | string | 否 | SFTP 通道配置。取值:
说明
| Enable |
SSHChannel | string | 否 | SSH 通道配置。取值:
说明
| Enable |
ExecCommand | string | 否 | 远程执行命令配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SFTPUploadFile | string | 否 | SFTP 选项文件上传配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SFTPDownloadFile | string | 否 | SFTP 选项文件下载配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SFTPRemoveFile | string | 否 | SFTP 选项删除文件配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SFTPRenameFile | string | 否 | SFTP 选项文件重命名配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SFTPMkdir | string | 否 | SFTP 选项创建文件夹配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
SFTPRmdir | string | 否 | SFTP 选项删除文件夹配置。取值:
说明
不填则默认设置为 Disable。
| Enable |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "81500666-d7f5-4143-8329-0223cc738105"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | 参数错误 |
404 | PolicyNotFound | The policy is not found. | 控制策略不存在 |
500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。