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

ImportHostsFromFile

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

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

我的收藏

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

请求说明

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

请求参数

参数类型是否必选示例值描述
ActionString是ImportHostsFromFile接口名称。当前 API 的名称为 ImportHostsFromFile。
VersionString是2021-06-01接口版本。当前 API 的版本为 2021-06-01。
InstanceIdString是vbh-14****0042-bhjml9w7云堡垒机 ID。
HostsArray of LocalHost是待导入的主机信息列表。
HostAccountObject of HostAccountInput否主机账号信息。

LocalHost

参数类型是否必选示例值描述
HostNameString是center主机名。
IpString是192.168.2.3主机 IP 地址。

OsType

String

是

Linux

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

  • Linux
  • Windows

Protocol

String

是

SSH

支持的连接协议。取值:

  • SSH
  • RDP
PortLong是22指定的连接端口。
HostGroupNamesArray of String是["vbh-node-group"]主机组名称列表。

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=ImportHostsFromFile&Version=2021-06-01
Content-Type: application/json
{
    "InstanceId": "vbh-14****0042-bhjml9w7",
    "Hosts": [
        {
            "HostName": "center",
            "Ip": "192.168.2.3",
            "OsType": "Linux",
            "Protocol": "SSH",
            "Port": 22,
            "HostGroupNames": ["vbh-node-group"]
        }
    ],
    "HostAccount": {
        "HostAccountName": "root",
        "AuthType": "Password",
        "Password": "qq******#1",
        "PrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----",
        "EncryptedKey": "pa******ase"
    }
}

返回参数

参数类型示例值描述
TotalCountLong22请求中的主机总数。
SuccessArray of LocalHostResp导入成功的主机信息列表。
FailureArray of LocalHostResp导入失败的主机信息列表。

LocalHostResp

参数类型示例值描述
HostNameStringhost-mlt主机名。
IpString192.168.3.123主机IP地址。
ReasonStringerror reason失败原因。
HostIdStringa47aa7c9-438d-11**-****-4ad9529a3e36成功导入主机 ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ImportHostsFromFile",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 22,
        "Success": [
            {
                "HostName": "host-bj",
                "Ip": "192.168.3.123",
                "Reason": "error reason",
                "HostId": "a47aa7c9-438d-11**-****-4ad9529a3e36"
            }
        ],
        "Failure": [
            {
                "HostName": "host-another",
                "Ip": "192.168.3.122",
                "Reason": "error reason",
                "HostId": ""
            }
        ]
    }
}

错误码

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