ImportHostsFromFile--云堡垒机-火山引擎

文档中心

立即注册

导航

ImportHostsFromFile

最近更新时间：2025.05.23 17:57:31首次发布时间：2023.12.15 10:45:21

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

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ImportHostsFromFile	接口名称。当前 API 的名称为 `ImportHostsFromFile`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机 ID。
Hosts	Array of LocalHost	是	[{"HostName": "test", "Ip": "2.2.2.2", "OsType": "Linux", "Protocol": "SSH", "Port": 2222, "HostGroupNames": ["name"]}]	待导入的主机信息列表。
HostAccount	Object of HostAccountInput	否	{"HostAccountName": "test", "AuthType": "Password", "Password": "Password", "PrivateKey": "key", "EncryptedKey": "key"}	主机账号信息。

LocalHost

参数	类型	是否必选	示例值	描述
Ip	String	是	2.2.2.2	主机名
Port	Long	是	65535	连接端口
OsType	String	是	Linux	机器系统
HostName	String	是	test	主机名
Protocol	String	是	ssh	连接协议
HostGroupNames	Array of String	是	["test"]	主机组名称列表

HostAccountInput

参数	类型	是否必选	示例值	描述
AuthType	String	是	Password" 或 "PrivateKey	验证方式
Password	String	否	Password	账户密码
PrivateKey	String	否	key	私钥
EncryptedKey	String	否	key	加密口令
HostAccountName	String	是	test	账户名称

请求示例

POST https://vbh.{RegionID}.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"
    }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	22	请求中的主机总数。
Success	Array of LocalHostResp	[{"HostId": "a47aa7c9-438d-11ec-a6f0-4ad9529a3e36", "HostName": "test", "Ip": "2.2.2.2", "Reason": "some reason"}]	导入成功的主机信息列表。
Failure	Array of LocalHostResp	[{"HostId": "a47aa7c9-438d-11ec-a6f0-4ad9529a3e36", "HostName": "test", "Ip": "2.2.2.2", "Reason": "some reason"}]	导入失败的主机信息列表。

LocalHostResp

参数	类型	示例值	描述
HostName	String	test	主机名
Ip	String	2.2.2.2	主机名
Reason	String	error reason	失败原因
HostId	String	a47aa7c9-438d-11ec-a6f0-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": ""
            }
        ]
    }
}

错误码

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