为指定主机创建主机账户。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 指定要创建主机账户的主机所在堡垒机的实例 ID。 说明
可通过调用 DescribeInstances 接口获取堡垒机实例 ID。
| bastionhost-cn-st220aw**** |
RegionId | string | 否 | 指定要创建主机账户的主机所在堡垒机的地域 ID。 说明
地域 ID 和地域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
HostId | string | 是 | 指定要创建主机账户的主机 ID。 说明
可通过调用 ListHosts 接口获取该参数。
| 1 |
ProtocolName | string | 是 | 指定新建主机账户的协议名称。
| SSH |
HostAccountName | string | 是 | 指定新建主机账户的名称,最长支持 128 字符。 | abc |
Password | string | 否 | 指定新建主机账户的密码。 | **** |
PrivateKey | string | 否 | 指定新建主机账户的私钥,即使用 Base64 编码后的字符串。 说明
主机账户协议 ProtocolName 为 SSH 时,该参数生效。ProtocolName 为 RDP 时,无需配置该参数。支持同时为主机账户配置密码和私钥。在连接资产时,堡垒机会优先使用私钥进行连接。
| **** |
PassPhrase | string | 否 | 定新建主机账户的私钥口令。 说明
主机账户协议 ProtocolName 为 SSH 时,您可以配置该参数。ProtocolName 为 RDP 时,无需配置该参数。
| **** |
HostShareKeyId | string | 否 | 主机共享密钥 ID。 | 1 |
返回参数
示例
正常返回示例
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. | 未知错误 |
访问错误中心查看更多错误码。