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

调试

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

请求参数

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

系统规定参数。取值:CreateHostAccount

InstanceId String bastionhost-cn-st220aw****

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

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

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

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

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

说明 可通过调用ListHosts接口获取该参数。
ProtocolName String SSH

指定新建主机账户的协议名称。

取值:

  • SSH
  • RDP
HostAccountName String abc

指定新建主机账户的名称,最长支持128字符。

Password String ****

指定新建主机账户的密码。

PrivateKey String ****

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

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

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

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

主机共享密钥ID。

返回数据

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

主机账户ID。

RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

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

示例

请求示例

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

正常返回示例

XML格式

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

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

JSON格式

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

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

错误码

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

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