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

CreateHost

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

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

我的收藏

新建单个主机，手动填写主机名、主机 IP、操作系统和协议端口信息，单个导入主机。

请求说明

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

请求参数

参数类型是否必选示例值描述
ActionString是CreateHost接口名称。当前 API 的名称为 CreateHost。
VersionString是2021-06-01接口版本。当前 API 的版本为 2021-06-01。
HostNameString是node-dwq212主机名。
IpString是192.168.2.1主机IP地址 。
InstanceIdString是vbh-14****0042-bhjml9w7云堡垒机实例 ID。

Source

String

否

local

主机来源。取值:

  • volc：火山引擎 ECS 主机。
  • local：本地主机，通过其它来源导入的主机。

OsType

String

否

Linux

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

  • Linux
  • Windows

Protocol

String

否

SSH

支持的连接协议。取值:

  • SSH
  • RDP
PortLong否22指定的连接端口。
HostGroupIdsArray of String否489bdb4f-0717-4d08-****-**08707f936关联主机组 ID。
HostAccountObject of HostAccountInput否主机账号信息。该主机账号用于登录主机。

HostAccountInput

参数类型是否必选示例值描述
HostAccountNameString是root主机账户名称。

AuthType

String

是

Password

用户身份验证方式。取值:

  • Password ：通过 Password 验证。
  • PrivateKey：  通过 PrivateKey 验证。
PasswordString否d12****231账户密码。
PrivateKeyString否-----BEGIN OPENSSH PRIVATE KEY-----用户私钥。需要确保对应的公钥位于目的主机之上，否则使用私钥无法连接成功。
EncryptedKeyString否pa******ase加密口令。

请求示例

POST https://open.volcengineapi.com/?Action=CreateHost&Version=2021-06-01
Content-Type: application/json
{
    "HostName": "vbh",
    "Ip": "192.168.2.1",
    "InstanceId": "vbh-14****0042-bhjml9w7",
    "Source": "volc",
    "OsType": "Linux",
    "Protocol": "SSH",
    "Port": 22,
    "HostGroupIds": "489bdb4f-0717-4d08-****-**08707f936",
    "HostAccount": {
        "HostAccountName": "root",
        "AuthType": "Password",
        "Password": "d12****231",
        "PrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----",
        "EncryptedKey": "pa******ase"
    }
}

返回参数

参数类型示例值描述
HostIdString2e7d77da-af08-4101-****-**4259701efb主机 ID 。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "CreateHost",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "HostId": "2e7d77da-af08-4101-****-**4259701efb"
    }
}

错误码

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