All Products
Search

This Product

    Bastionhost:ModifyHostsPort

    Document Center

    Bastionhost:ModifyHostsPort

    Last Updated:Sep 29, 2026

    Modifies the ports used by Bastionhost for the RDP and SSH protocols on hosts. By default, Bastionhost uses port 3389 for RDP and port 22 for SSH. If you have configured custom ports on your hosts, you can call this operation to update the port settings.

    Operation description

    Usage notes

    This operation modifies the ports of O&M protocols for multiple hosts. If you consider the standard ports of O&M protocols insecure and vulnerable to attacks, such as port 22 for SSH, you can call this operation to specify custom ports.

    Note

    Ports 0 to 1024 are reserved for Bastionhost. Do not specify a reserved port as a custom port.

    QPS limits

    You can call this operation up to 10 times per second. Requests that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.

    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:ModifyHostsPort

    update

    *Instance

    acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the Bastionhost instance where the hosts whose protocol ports you want to modify reside.

    Note

    You can call the DescribeInstances operation to query the instance ID.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the Bastionhost instance where the hosts whose ports you want to modify reside.

    Note

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

    cn-hangzhou
    HostIds

    string

    Yes

    The IDs of the hosts whose O&M protocols and ports you want to modify. The value is a JSON string. You can enter up to 100 host IDs. Separate multiple host IDs with commas (,).

    Note

    You can call the ListHosts operation to query the host IDs.

    ["1","2","3"]
    ProtocolName

    string

    Yes

    The name of the protocol whose port you want to modify. Valid values:

    • SSH

    • RDP

    SSH
    Port

    string

    Yes

    The new port number. The port number must be an integer. Valid values: 22 to 65535.

    22
    ProjectId

    integer

    No

    The project ID.

    3

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request, which is generated by Alibaba Cloud and can be used to troubleshoot issues.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    Results

    array<object>

    The results of the operation.

    object

    Code

    string

    The result of the operation. Valid values:

    • OK: The operation is successful.

    • UNEXPECTED: An unknown error occurred.

    • INVALID_ARGUMENT: A request parameter is invalid.

      Note

      Check the request parameters and try again.

    • OBJECT_NOT_FOUND: The specified object does not exist.

      Note

      Check whether the Bastionhost instance ID and host ID are valid and whether the host exists, and then try again.

    • OBJECT_AlREADY_EXISTS: The specified object already exists.

    OK
    Message

    string

    [Deprecated] This parameter is deprecated. Ignore this parameter.

    None
    HostId

    string

    The ID of the host.

    1

    Examples

    Success response

    JSON format

    {
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "None",
      "HostId": "1"
    }
  ]
}

    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.