支持修改主机的地址、名称、操作系统类型和备注信息。
接口说明
该接口支持修改本地主机、ECS 主机、RDS 专属集群主机的基本信息。
说明
如果您修改了 ECS 主机或 RDS 专属集群主机的基本信息,由于堡垒机系统会定期同步 ECS 主机、RDS 专属集群主机的基本信息,修改结果可能会被 ECS 主机或 RDS 专属集群主机所同步的基本信息覆盖。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-bastionhost:ModifyHost | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 指定要修改的主机所在堡垒机的实例 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。
| bastionhost-cn-st220aw**** |
RegionId | string | 否 | 指定要修改的主机所在堡垒机的区域 ID。 说明
Region ID 和区域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
HostId | string | 是 | 指定要修改的主机 ID。 说明
您可以调用 ListHosts 接口获取该参数。
| 1 |
HostPrivateAddress | string | 否 | 指定修改后主机的私网地址,可使用域名或 IP 地址。 | 193.168.XX.XX |
HostPublicAddress | string | 否 | 指定修改后主机的公网地址,可使用域名或 IP 地址。 | 200.1.XX.XX |
OSType | string | 否 | 指定修改后主机的操作系统类型。取值:
| Linux |
HostName | string | 否 | 指定修改后主机的名称,最多支持 128 字符。 | TestHost |
Comment | string | 否 | 指定修改后主机的备注信息,最多支持 500 字符。 | Host for test. |
NetworkDomainId | string | 否 | 指定修改后主机所属的网络域 ID。 说明
您可以调用ListNetworkDomains 接口获取该参数。
| 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | 参数错误 |
400 | HostNotFound | The host is not found. | 主机不存在 |
500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-11-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |