CreateHostAccount - 为指定主机创建主机账户

在堡垒机中新建主机后,您可以为其创建相应的主机账户,即将您主机已有的账户托管至堡垒机。创建主机账户后,运维人员即可使用该账户通过堡垒机登录主机进行运维。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-bastionhost:CreateHostAccount

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

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

说明

可通过调用 DescribeInstances 接口获取堡垒机实例 ID。

bastionhost-cn-st220aw****

RegionId

string

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

说明

地域 ID 和地域名称的对应关系,请参见地域和可用区

cn-hangzhou

HostId

string

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

说明

可通过调用 ListHosts 接口获取该参数。

1

ProtocolName

string

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

  • SSH

  • RDP

SSH

HostAccountName

string

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

accountname

Password

string

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

123456

PrivateKey

string

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

说明

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

-----BEGIN RSA PRIVATE KEY----- ...... -----END RSA PRIVATE KEY-----

PassPhrase

string

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

说明

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

123456

HostShareKeyId

string

主机共享密钥 ID。

1

PrivilegeType

string

账户权限类型,不填时默认为 Normal

  • Privileged:特权账户

  • Normal:普通账户

说明

仅支持 V3.2.47 及以上的版本使用。

Normal

RotationMode

string

账户改密模式,不填时默认为 Self

  • Privileged:使用特权账户改密

  • Self:不使用特权账户改密

说明

仅支持 V3.2.47 及以上的版本使用。

Self

返回参数

名称

类型

描述

示例值

object

HostAccountId

string

主机账户 ID。

1

RequestId

string

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

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

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

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

变更历史

更多信息,参考变更详情