All Products
Search
Document Center

Bastionhost:ModifyHostsPort

Last Updated:Oct 25, 2023

Changes the port for the O\\\\\\&M protocol on one or more hosts.

Operation Description

Usage notes

You can call this operation to change the port for the O&M protocol on one or more hosts. If the standard port for the O&M protocol on your host is vulnerable to attacks, you can call this operation to specify a custom port. For example, the standard port for SSH is port 22.

Note Ports 0 to 1024 are reserved for Bastionhost. Do not change the port for the O&M protocol to a reserved port.

QPS limit

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:ModifyHostsPortWrite
    All Resources
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host for which you want to change the port of the host.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
bastionhost-cn-st220aw****
RegionIdstringNo

The region ID of the bastion host for which you want to change the port of the host.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
HostIdsstringYes

The ID of the host for which you want to change the port. The value is a JSON string. You can add up to 100 host IDs. If you specify multiple IDs, separate the IDs with commas (,).

Note You can call the ListHosts operation to query the IDs of hosts.
["1","2","3"]
ProtocolNamestringYes

The protocol that is used to connect to the host. Valid values:

  • SSH
  • RDP
SSH
PortstringYes

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

22

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Resultsobject []

The result of the call.

Codestring

The return code that indicates whether the call was successful. Valid values:

  • OK: The call was successful.

  • UNEXPECTED: An unknown error occurred.

  • INVALID_ARGUMENT: A request parameter is invalid.

    Note Make sure that the request parameters are valid and call the operation again.
  • OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist.

    Note Check whether the specified ID of the bastion host exists, whether the specified hosts exist, and whether the specified host IDs are valid. Then, call the operation again.
  • OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.

OK
Messagestring

This parameter is deprecated.

-
HostIdstring

The ID of the host.

1

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.