调用ModifyHostAccount接口修改主机账户信息,支持修改主机账户的名称、密码和私钥信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyHostAccount

系统规定参数。取值:ModifyHostAccount

InstanceId String bastionhost-cn-st220aw****

指定要修改的主机账户所在堡垒机的实例ID。

说明 可通过调用DescribeInstances接口获取堡垒机实例ID。
RegionId String cn-hangzhou

指定要查询的主机账户所在堡垒机的区域ID。

说明 地域ID和地域名称的对应关系,请参见地域和可用区
HostAccountId String 1

指定要修改的主机账户ID。

说明 您可以调用ListHostAccounts接口获取该参数。
HostAccountName String abc

指定修改后的主机账户名称,最多支持128字符。

Password String ****

指定修改后的主机账户密码。

PrivateKey String ****

指定修改后的主机账户私钥,私钥为使用Base64编码后的字符串。

说明 主机账户协议为SSH时,该参数生效。主机账户协议为RDP时,无需配置该参数。您可以调用GetHostAccount接口查询主机账户使用的协议。支持同时为主机账户配置密码和私钥。在连接资产时,堡垒机会优先使用私钥进行连接。
PassPhrase String ****

指定修改后的主机账户的私钥口令。

说明 主机账户协议为SSH时,该参数生效。主机账户协议为RDP时,无需配置该参数。
HostShareKeyId String 1

主机共享密钥ID。

返回数据

名称 类型 示例值 描述
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

阿里云为该请求生成的唯一标识符。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyHostAccount
&InstanceId=bastionhost-cn-st220aw****
&RegionId=cn-hangzhou
&HostAccountId=1
&HostAccountName=abc
&Password=****
&PrivateKey=****
&PassPhrase=****
&HostShareKeyId=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyHostAccountResponse>
    <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
</ModifyHostAccountResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter The argument is invalid. 参数错误
404 HostAccountNotFound The host account is not found. 主机账号不存在
500 InternalError An unknown error occurred. 未知错误

访问错误中心查看更多错误码。