All Products
Search

This Product

    Bastionhost:SetPolicyProtocolConfig

    Document Center

    Bastionhost:SetPolicyProtocolConfig

    Last Updated:Sep 29, 2026

    Configures the RDP, SSH, and SFTP options of a control policy.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-bastionhost:SetPolicyProtocolConfig

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID of the bastion host.

    Note

    You can invoke DescribeInstances to obtain this parameter.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the bastion host.

    Note

    For the mapping between region IDs and region names, see Regions and zones.

    cn-hangzhou
    PolicyId

    string

    Yes

    The ID of the control policy to modify.

    Note

    You can call ListPolicies to obtain this parameter.

    61
    ProtocolConfig

    object

    Yes

    The protocol control configuration.

    RDP

    object

    No

    The RDP option configuration details.

    RecordKeyboard

    string

    No

    The keyboard recording configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    DiskRedirection

    string

    No

    The drive/printer mapping configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    ClipboardDownload

    string

    No

    The clipboard download configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    ClipboardUpload

    string

    No

    The clipboard upload configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    DiskRedirectionUpload

    string

    No

    Specifies whether to allow disk upload.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    DiskRedirectionDownload

    string

    No

    Specifies whether to allow disk download.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SSH

    object

    No

    The SSH and SFTP option configuration details.

    X11Forwarding

    string

    No

    The X11 forwarding configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SFTPChannel

    string

    No

    The SFTP channel configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    • If this parameter is not specified, the default value is Disable.

    • At least one of the SSH channel and SFTP channel must be set to Enable.

    • If you enable the SFTP-only permission for a host account, do not disable both the SSH channel and SFTP channel for that account in the control policy. Otherwise, you cannot use the host account to access the target server through the bastion host.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SSHChannel

    string

    No

    The SSH channel configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    • If this parameter is not specified, the default value is Disable.

    • At least one of the SSH channel and SFTP channel must be set to Enable. If the SSH channel is set to Disable, you cannot log on to asset accounts by using SSH permissions. Proceed with caution.

    • If you enable the SFTP-only permission for a host account, do not disable both the SSH channel and SFTP channel for that account in the control policy. Otherwise, you cannot use the host account to access the target server through the bastion host.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    ExecCommand

    string

    No

    The remote command execution configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SFTPUploadFile

    string

    No

    The SFTP file upload configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SFTPDownloadFile

    string

    No

    The SFTP file download configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SFTPRemoveFile

    string

    No

    The SFTP file deletion configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SFTPRenameFile

    string

    No

    The SFTP file rename configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SFTPMkdir

    string

    No

    The SFTP folder creation configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    SFTPRmdir

    string

    No

    The SFTP folder deletion configuration. Valid values:

    • Enable: Enabled.

    • Disable: Disabled.

    Note

    If this parameter is not specified, the default value is Disable.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    AllowDirectTcp

    string

    No

    Specifies whether to allow direct TCP connection.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    TcpForwarding

    string

    No

    Specifies whether to allow TCP forwarding.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    AllowTcpForwarding

    string

    No

    Specifies whether to allow TCP forwarding.

    Valid values:

    • Enable :

      Enabled.

    • Disable :

      Disabled.

    Enable
    ProjectId

    integer

    No

    The project ID.

    3

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique request ID generated by Alibaba Cloud for this request.

    81500666-d7f5-4143-8329-0223cc738105

    Examples

    Success response

    JSON format

    {
  "RequestId": "81500666-d7f5-4143-8329-0223cc738105"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The argument is invalid. The argument is invalid.
    500 InternalError An unknown error occurred. An unknown error occurred.
    404 PolicyNotFound The policy is not found. The policy is not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.