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

文档中心

立即注册

导航

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

请求参数

参数	类型	是否必选	示例值	描述
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	是		待导入的主机信息列表。
HostAccount	Object of HostAccountInput	否		主机账号信息。

LocalHost

参数	类型	是否必选	示例值	描述
HostName	String	是	center	主机名。
Ip	String	是	192.168.2.3	主机 IP 地址。
OsType	String	是	Linux	主机操作系统类型。取值: Linux Windows
Protocol	String	是	SSH	支持的连接协议。取值: SSH RDP
Port	Long	是	22	指定的连接端口。
HostGroupNames	Array of String	是	["vbh-node-group"]	主机组名称列表。

HostAccountInput

参数	类型	是否必选	示例值	描述
HostAccountName	String	是	root	主机账户名称。
AuthType	String	是	Password	用户身份验证方式。取值: Password ：通过 Password 验证。 PrivateKey：通过 PrivateKey 验证。
Password	String	否	d12****231	账户密码。
PrivateKey	String	否	-----BEGIN OPENSSH PRIVATE KEY-----	用户私钥。需要确保对应的公钥位于目的主机之上，否则使用私钥无法连接成功。
EncryptedKey	String	否	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"
    }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	22	请求中的主机总数。
Success	Array of LocalHostResp		导入成功的主机信息列表。
Failure	Array of LocalHostResp		导入失败的主机信息列表。

LocalHostResp

参数	类型	示例值	描述
HostName	String	host-mlt	主机名。
Ip	String	192.168.3.123	主机IP地址。
Reason	String	error reason	失败原因。
HostId	String	a47aa7c9-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": ""
            }
        ]
    }
}

错误码

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