全部产品
Search
文档中心

运维安全中心(堡垒机):CreateHostAccount - 为指定主机创建主机账户

更新时间:Mar 01, 2024

为指定主机创建主机账户。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

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

说明 可通过调用 DescribeInstances 接口获取堡垒机实例 ID。
bastionhost-cn-st220aw****
RegionIdstring

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

说明 地域 ID 和地域名称的对应关系,请参见地域和可用区
cn-hangzhou
HostIdstring

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

说明 可通过调用 ListHosts 接口获取该参数。
1
ProtocolNamestring

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

  • SSH
  • RDP
SSH
HostAccountNamestring

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

abc
Passwordstring

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

****
PrivateKeystring

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

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

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

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

主机共享密钥 ID。

1

返回参数

名称类型描述示例值
object
HostAccountIdstring

主机账户 ID。

1
RequestIdstring

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
400HostAccountAlreadyExistsThe host account already exists.主机账号已存在
500InternalErrorAn unknown error occurred.未知错误

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