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

文档中心

立即注册

导航

CreateHostAccount

最近更新时间：2024.04.16 19:47:31首次发布时间：2023.12.15 10:45:21

新建主机账号，云堡垒机新建主机账号与主机中已经创建的操作系统账号一致，即可通过该账号访问主机。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateHostAccount	接口名称。当前 API 的名称为 `CreateHostAccount`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
HostAccountName	String	是	root	账户名称。同一个主机的主机账户名不能重复。
Password	String	否	Password	账户密码。
HostIds	Array of String	是	["2e7d77da-af08-41-**-e44259701efb"]	主机 ID 列表。
AuthType	String	是	Password	用户身份验证方式。取值: Password：通过 Password 验证。 PrivateKey：通过 PrivateKey 验证。
PrivateKey	String	是	-----BEGIN OPENSSH PRIVATE KEY-----	私钥信息。如果 AuthType 指定为 PrivateKey，需要指定私钥。
EncryptedKey	String	否	pa******ase	加密口令。创建私钥时指定的加密口令。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机 ID。

请求示例

POST https://open.volcengineapi.com/?Action=CreateHostAccount&Version=2021-06-01
Content-Type: application/json
{
    "HostAccountName": "root",
    "Password": "Password",
    "HostIds": ["2e7d77da-af08-41**-****-e44259701efb"],
    "AuthType": "Password",
    "PrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----",
    "EncryptedKey": "pa******ase",
    "InstanceId": "vbh-14****0042-bhjml9w7"
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	22	请求中的账户总数。
Success	Array of HostAccountRes		导入成功的账户列表。
Failure	Array of HostAccountRes		导入失败的账户列表。

HostAccountRes

参数	类型	示例值	描述
HostAccountId	String	a47aa7c9-438d-11-**-4ad9529a3e36	主机账号 ID。
HostAccountName	String	root	账户名称。
HostName	String	host-mlt	主机名称。
Reason	String	some reason	导入失败原因。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "CreateHostAccount",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 22,
        "Success": [
            {
                "HostAccountId": "a47aa7c9-438d-11**-****-4ad9529a3e36",
                "HostAccountName": "root",
                "HostName": "host-mlt",
                "Reason": "some reason"
            }
        ],
        "Failure": [
            {
                "HostAccountId": "a47aa7c9-438d-11**-****-4ad9529a3e36",
                "HostAccountName": "root",
                "HostName": "host-mlt",
                "Reason": "some reason"
            }
        ]
    }
}

错误码

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