调用ModifyHostsPort接口批量修改主机运维协议的端口。

使用说明

本接口用于批量修改主机运维协议的端口。如果您认为使用运维协议的标准端口不安全(如SSH运维协议的标准端口为22),容易被攻击者发现并入侵,您可以使用本接口自定义运维协议的端口。

说明 0~1024为堡垒机保留端口,自定义端口时请不要修改为保留端口。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyHostsPort

需要执行的操作。

取值:ModifyHostsPort

HostIds String ["1","2","3"]

要修改运维协议和端口的主机ID。该参数为JSON格式的字符串,最多可输入100个主机ID。多个主机ID之间使用半角逗号(,)隔开。

说明 您可以调用ListHosts接口获取该参数。
InstanceId String bastionhost-cn-st220aw****

要修改协议端口的主机所在堡垒机的实例ID。

说明 您可以调用DescribeInstances接口获取该参数。
Port String 22

修改后的端口号。端口号为整数,取值范围:22~65535。

ProtocolName String SSH

要修改端口的协议名称。取值:

  • SSH
  • RDP
RegionId String cn-hangzhou

要修改端口的主机所在堡垒机的区域ID。

说明 区域ID和区域名称的对应关系,请参见地域和可用区

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

Results Array of Item

接口调用的结果。

Code String OK

接口调用的结果。取值:

  • OK:操作成功。
  • UNEXPECTED:未知错误。
  • INVALID_ARGUMENT:请求参数设置错误。
    说明 请检查请求参数,确保参数正确后重新调用接口。
  • OBJECT_NOT_FOUND:操作的对象不存在。
    说明 请检查该堡垒机实例的ID是否存在,主机是否存在,主机ID是否填写正确,然后重新调用接口。
  • OBJECT_AlREADY_EXISTS :操作的对象已存在。
HostId String 1

主机ID。

Message String

该参数已废弃,无需关注。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyHostsPort
&HostIds=["1","2","3"]
&InstanceId=bastionhost-cn-st220aw****
&Port=22
&ProtocolName=SSH
&<公共请求参数>

正常返回示例

XML格式

<ModifyHostsPortResponse>
  <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
  <Results>
        <Message>无</Message>
        <HostId>1</HostId>
        <Code>OK</Code>
  </Results>
</ModifyHostsPortResponse>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An unknown error occurred. 未知错误
400 InvalidParameter The argument is invalid. 参数错误

访问错误中心查看更多错误码。