调用CreateHostAccount接口为指定主机创建主机账户。

使用说明

本接口用于为指定主机创建主机账户，支持为主机账户配置密码或私钥。新建主机账户是指将您主机系统内存在的账号配置到堡垒机中，以便运维人员使用堡垒机登录主机。

说明 在堡垒机中新建的主机账号不会同步到您的主机系统内。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

请求参数

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

需要执行的操作。

取值：CreateHostAccount。

HostAccountName String 是 abc

要新建主机账户的主机名称，最长支持128字符。
HostId String 是 1

要创建主机账户的主机ID。

说明 您可以调用ListHosts接口获取该参数。
InstanceId String 是 bastionhost-cn-st220aw****

要创建主机账户的主机所在堡垒机的实例ID。

说明 您可以调用DescribeInstances接口获取该参数。
ProtocolName String 是 SSH

要新建主机账户的主机的运维协议的名称。取值：

  • SSH
  • RDP
RegionId String 否 cn-hangzhou

要创建主机账户的主机所在堡垒机的地域ID。

说明 地域ID和地域名称的对应关系，请参见地域和可用区。
Password String 否 ****

要新建主机账户的账户密码。
PrivateKey String 否 ****

要新建主机账户的私钥，即使用Base64编码后的字符串。

说明 主机账户运维协议ProtocolName为SSH时，该参数生效。ProtocolName为RDP时，无需配置该参数。支持同时为主机账户配置密码和私钥。在连接资产时，堡垒机会优先使用私钥进行连接。
PassPhrase String 否 ****

要新建主机账户的私钥口令。

说明 主机账户协议ProtocolName为SSH时，您可以配置该参数。ProtocolName为RDP时，无需配置该参数。

调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用API的请求格式，请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
HostAccountId String 1

主机账户ID。
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateHostAccount
&HostAccountName=abc
&HostId=1
&InstanceId=bastionhost-cn-st220aw****
&ProtocolName=SSH
&Password=****
&<公共请求参数>

正常返回示例

XML格式 

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

JSON格式 

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An unknown error occurred. 未知错误
400 InvalidParameter The argument is invalid. 参数错误
400 HostAccountAlreadyExists The host account already exists. 主机账号已存在

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