堡垒机对于服务器的RDP和SSH协议使用的是默认端口(RDP协议默认使用3389端口,SSH协议默认使用22端口),如果您在主机中自定义了端口,可通过本接口进行修改。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-bastionhost:ModifyHostsPort | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 要修改协议端口的主机所在堡垒机的实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。
| bastionhost-cn-st220aw**** |
RegionId | string | 否 | 要修改端口的主机所在堡垒机的区域 ID。 说明
区域 ID 和区域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
HostIds | string | 是 | 要修改运维协议和端口的主机 ID。该参数为 JSON 格式的字符串,最多可输入 100 个主机 ID。多个主机 ID 之间使用半角逗号(,)隔开。 说明
您可以调用 ListHosts 接口获取该参数。
| ["1","2","3"] |
ProtocolName | string | 是 | 要修改端口的协议名称。取值:
| SSH |
Port | string | 是 | 修改后的端口号。端口号为整数,取值范围:22~65535。 | 22 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"Results": [
{
"Code": "OK",
"Message": "无",
"HostId": "1"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | 参数错误 |
500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。