最近更新时间：2024.04.16 19:47:30
首次发布时间：2023.12.15 10:45:21
导入火山引擎 ECS 主机，可自动获取主机名、主机 IP、操作系统和协议端口信息，将火山引擎中的 ECS 主机一键导入云堡垒机。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| 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 | String | 是 | root | 主机账户名称。 |
AuthType | String | 是 | Password | 用户身份验证方式。取值:
|
| Password | String | 否 | d12****231 | 账户密码。 |
| PrivateKey | String | 否 | -----BEGIN OPENSSH PRIVATE KEY----- | 用户私钥。需要确保对应的公钥位于目的主机之上，否则使用私钥无法连接成功。 |
| EncryptedKey | String | 否 | pa******ase | 加密口令。 |
POST https://open.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 | 导入成功的主机列表。 | |
| Failure | Array of EcsInstance | 导入失败的主机列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| EcsInstanceId | String | a47aa7c9-438d-11**-****-4ad9529a3e36 | ECS ID。 |
| HostName | String | host-mlt | 主机名。 |
| Ip | String | 192.168.2.3 | 主机 IP 地址。 |
OsType | String | Linux | 主机操作系统类型。取值:
|
| Imported | Boolean | true | 该主机是否之前已经导入过。 |
| Vpc | String | v172 | VPC 名称。 |
| VpcId | String | vpc-3reyo******wg5zsk2hn63665 | VPC 对应的 ID。 |
Protocol | String | SSH | 支持的连接协议。取值:
|
| Port | Long | 22 | 主机的连接端口。 |
| HostId | String | a47aa7c9-438d-11**-****-4ad9529a3e36 | 主机 ID。 |
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": "" } ] } }
当前接口暂无独立错误码，若接口调用返回异常，可参考 公共错误码 进行故障排查。