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

文档中心

立即注册

导航

ImportHostsFromEcs

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

导入火山引擎 ECS 主机，可自动获取主机名、主机 IP、操作系统和协议端口信息，将火山引擎中的 ECS 主机一键导入云堡垒机。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ImportHostsFromEcs	接口名称。当前 API 的名称为 `ImportHostsFromEcs`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
EcsInstanceIds	Array of String	是	["a47aa7c9-438d-11ec--**d9529a3e36"]	ECS 主机 ID 列表。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机 ID 列表。
HostAccount	Object of HostAccountInput	否	{"HostAccountName": "test", "AuthType": "Password", "Password": "Password", "PrivateKey": "key", "EncryptedKey": "key"}	主机账号信息，该账号用于登录主机。
RegionId	String	否	cn-hangzhou	region id

HostAccountInput

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

请求示例

POST https://vbh.{RegionID}.volcengineapi.com/?Action=ImportHostsFromEcs&Version=2021-06-01
Content-Type: application/json
{
    "EcsInstanceIds": [
        "a47aa7c9-438d-11**-****-4ad9529a3e36"
    ],
    "InstanceId": "vbh-14****0042-bhjml9w7",
    "HostAccount": {
        "HostAccountName": "root",
        "AuthType": "Password",
        "Password": "qq******@1",
        "PrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----",
        "EncryptedKey": "pa******ase"
    }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	22	请求导入的主机总数。
Success	Array of EcsInstance	[{"HostId": "a47aa7c9-438d-11ec-a6f0-4ad9529a3e36", "Port": 3333, "Protocol": "ssh", "VpcId": "vpc-3reyos6qtqfwg5zsk2hn63665", "Vpc": "v172", "Imported": true, "OsType": "Linux", "Ip": "22.2.2.2", "HostName": "test", "EcsInstanceId": "a47aa7c9-438d-11ec-a6f0-4ad9529a3e36"}]	导入成功的主机列表。
Failure	Array of EcsInstance	[{"HostId": "a47aa7c9-438d-11ec-a6f0-4ad9529a3e36", "Port": 3333, "Protocol": "ssh", "VpcId": "vpc-3reyos6qtqfwg5zsk2hn63665", "Vpc": "v172", "Imported": true, "OsType": "Linux", "Ip": "22.2.2.2", "HostName": "test", "EcsInstanceId": "a47aa7c9-438d-11ec-a6f0-4ad9529a3e36"}]	导入失败的主机列表。

EcsInstance

参数	类型	示例值	描述
EcsInstanceId	String	a47aa7c9-438d-11ec-a6f0-4ad9529a3e36	Id
HostName	String	test	主机名
Ip	String	2.2.2.2	主机名
OsType	String	Linux	机器系统
Imported	Boolean	true	是否已导入
Vpc	String	v172	VPC
VpcId	String	vpc-3reyos6qtqfwg5zsk2hn63665	VPC ID
Protocol	String	ssh	连接协议
Port	Long	65535	连接端口
HostId	String	a47aa7c9-438d-11ec-a6f0-4ad9529a3e36	主机 ID
Tags	Array of Tag	{}	主机标签
RegionId	String	cn-hangzhou	region id

Tag

参数	类型	示例值	描述
Key	String	key	Tag key
Value	String	value	Tag value

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ImportHostsFromEcs",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 22,
        "Success": [
            {
                "EcsInstanceId": "a47aa7c9-438d-11**-****-4ad9529a3e36",
                "HostName": "host-bj",
                "Ip": "192.168.2.3",
                "OsType": "Linux",
                "Imported": true,
                "Vpc": "v172",
                "VpcId": "vpc-3reyo******wg5zsk2hn63665",
                "Protocol": "SSH",
                "Port": 22,
                "HostId": "a47aa7c9-438d-11**-****-4ad9529a3e36"
            }
        ],
        "Failure": [
            {
                "EcsInstanceId": "a47aa7c9-****-**ec-a6f0-4ad9529a3e36",
                "HostName": "host-bj",
                "Ip": "192.168.2.3",
                "OsType": "Linux",
                "Imported": true,
                "Vpc": "v172",
                "VpcId": "vpc-3reyo******wg5zsk2hn63665",
                "Protocol": "SSH",
                "Port": 22,
                "HostId": ""
            }
        ]
    }
}

错误码

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