All Products
Search

This Product

    Bastionhost:SetPolicyProtocolConfig

    Document Center

    Bastionhost:SetPolicyProtocolConfig

    Last Updated:Jan 22, 2026

    Sets the Remote Desktop Protocol (RDP), Secure Shell (SSH), and SSH File Transfer Protocol (SFTP) options for 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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the Bastionhost instance.

    Note

    Call the DescribeInstances operation to obtain the instance ID.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The ID of the region where the Bastionhost instance resides.

    Note

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

    cn-hangzhou
    PolicyId

    string

    Yes

    The ID of the control policy that you want to modify.

    Note

    Call the ListPolicies operation to obtain the policy ID.

    61
    ProtocolConfig

    object

    Yes

    The protocol control configuration.

    RDP

    object

    No

    The RDP options.

    RecordKeyboard

    string

    No

    Specifies whether to record keyboard input. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    DiskRedirection

    string

    No

    Specifies whether to enable drive and printer mapping. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    ClipboardDownload

    string

    No

    Specifies whether to allow clipboard content to be downloaded. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    ClipboardUpload

    string

    No

    Specifies whether to allow clipboard content to be uploaded. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    DiskRedirectionUpload

    string

    No

    Enable
    DiskRedirectionDownload

    string

    No

    Enable
    SSH

    object

    No

    The SSH and SFTP options.

    X11Forwarding

    string

    No

    Specifies whether to enable X11 forwarding. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    SFTPChannel

    string

    No

    Specifies whether to enable the SFTP channel. Valid values:

    • Enable

    • Disable

    Note

    • The default value is Disable.

    • At least one of the SSH channel and the SFTP channel must be enabled.

    • If you grant only SFTP permissions to a host account, do not disable the SSH and SFTP channels for that account in the control policy. Otherwise, you cannot use the host account to access the target server through Bastionhost.

    Enable
    SSHChannel

    string

    No

    Specifies whether to enable the SSH channel. Valid values:

    • Enable

    • Disable

    Note

    • The default value is Disable.

    • At least one of the SSH channel and the SFTP channel must be enabled. If you disable the SSH channel, you cannot use SSH permissions to log on to the asset account. Configure this parameter with caution.

    • If you grant only SFTP permissions to a host account, do not disable the SSH and SFTP channels for that account in the control policy. Otherwise, you cannot use the host account to access the target server through Bastionhost.

    Enable
    ExecCommand

    string

    No

    Specifies whether to allow remote command execution. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    SFTPUploadFile

    string

    No

    Specifies whether to allow file uploads over SFTP. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    SFTPDownloadFile

    string

    No

    Specifies whether to allow file downloads over SFTP. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    SFTPRemoveFile

    string

    No

    Specifies whether to allow file deletions over SFTP. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    SFTPRenameFile

    string

    No

    Specifies whether to allow file renames over SFTP. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    SFTPMkdir

    string

    No

    Specifies whether to allow folder creation over SFTP. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    SFTPRmdir

    string

    No

    Specifies whether to allow folder deletion over SFTP. Valid values:

    • Enable

    • Disable

    Note

    The default value is Disable.

    Enable
    AllowDirectTcp

    string

    No

    Enable
    AllowTcpForwarding

    string

    No

    Enable

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the 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.