You need to enable JavaScript to run this app.
导航
云堡垒机
  • 文档首页
    • /
  • 云堡垒机

UpdateHost

最近更新时间：2024.04.16 19:47:30

首次发布时间：2023.12.15 10:45:21

我的收藏

更新主机信息，修改已导入云堡垒机主机的配置信息。

接口说明

火山引擎 ECS 导入的主机，不支持修改主机名、主机类型、主机IP地址以及协议类型配置。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=UpdateHost&Version=2021-06-01

请求参数

参数类型是否必选示例值描述
ActionString是UpdateHost接口名称。当前 API 的名称为 UpdateHost。
VersionString是2021-06-01接口版本。当前 API 的版本为 2021-06-01。
HostNameString否vbh主机名。
IpString否192.168.3.2主机 IP 地址。
HostIdString是a47aa7c9-438d-11**-****-4ad9529a3e36主机 ID。

Protocol

String

否

SSH

支持的连接协议。取值:

  • SSH
  • RDP
PortLong否22指定的连接端口。

OsType

String

否

Linux

主机操作系统类型。取值:

  • Linux
  • Windows

说明

如果是从火山引擎 ECS 导入的资源，主机类型不支持修改。

HostGroupIdsArray of String否489bdb4f-0717-4d**-****-c5608707f936主机关联的主机组 ID。
InstanceIdString是vbh-14****0042-bhjml9w7云堡垒机 ID。

请求示例

POST https://open.volcengineapi.com/?Action=UpdateHost&Version=2021-06-01
Content-Type: application/json
{
    "HostName": "vbh",
    "Ip": "192.168.3.2",
    "HostId": "a47aa7c9-438d-11**-****-4ad9529a3e36",
    "Protocol": "SSH",
    "Port": 22,
    "OsType": "Linux",
    "HostGroupIds": "489bdb4f-0717-4d**-****-c5608707f936",
    "InstanceId": "vbh-14****0042-bhjml9w7"
}

返回参数

无

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "UpdateHost",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考 公共错误码 进行故障排查。