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

文档中心

立即注册

导航

UpdateHostAccount

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

更新主机账号。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateHostAccount	接口名称。当前 API 的名称为 `UpdateHostAccount`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
HostAccountName	String	否	root	主机账户名称。
Password	String	否	Password	主机账户密码。
HostAccountId	String	是	81afdb30-9de9-11-**-4645cf75c406	主机账号 ID。
AuthType	String	否	Password	用户身份验证方式。取值: Password：通过 Password 验证。 PrivateKey：通过 PrivateKey 验证。
PrivateKey	String	否	-----BEGIN OPENSSH PRIVATE KEY-----	身份认证所需的私钥。
EncryptedKey	String	否	phd******	私钥的加密口令。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机 ID。

请求示例

POST https://open.volcengineapi.com/?Action=UpdateHostAccount&Version=2021-06-01
Content-Type: application/json
{
    "HostAccountName": "root",
    "Password": "Password",
    "HostAccountId": "81afdb30-9de9-11**-****-4645cf75c406",
    "AuthType": "Password",
    "PrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----",
    "EncryptedKey": "phd******",
    "InstanceId": "vbh-14****0042-bhjml9w7"
}

返回参数

无

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "UpdateHostAccount",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

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