Adds a host account to a specified host.

Usage notes

You can call this operation to add a host account to a specified host. You can also configure a password or a private key for the host account. You can add an existing host account in your host system to a host. Then, an O&M personnel can use the host account to log on to the host in Bastionhost.

Note A host account that is added to a host in Bastionhost is not synchronized to your host system.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateHostAccount

The operation that you want to perform.

Set the value to CreateHostAccount.

HostAccountName String Yes abc

The name of the host account that you want to add. The name can be up to 128 characters in length.

HostId String Yes 1

The ID of the host to which you want to add a host account.

Note You can call the ListHosts operation to query the ID of the host.
InstanceId String Yes bastionhost-cn-st220aw****

The ID of the bastion host in which you want to add a host account to the host.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
ProtocolName String Yes SSH

The O&M protocol of the host to which you want to add a host account. Valid values:

  • SSH
  • RDP
RegionId String No cn-hangzhou

The region ID of the bastion host in which you want to add a host account to the host.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
Password String No ****

The password of the host account.

PrivateKey String No ****

The private key of the host account. The value is a Base64-encoded string.

Note This parameter takes effect only when the ProtocolName parameter is set to SSH. If the ProtocolName parameter is set to RDP, you do not need to specify this parameter. You can configure a password and a private key for the host account at the same time. If both a password and a private key are configured for the host account, Bastionhost preferentially uses the private key to log on to the host.
PassPhrase String No ****

The passphrase of the private key for the host account.

Note You can specify this parameter when the ProtocolName parameter is set to SSH. If the ProtocolName parameter is set to RDP, you do not need to specify this parameter.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
HostAccountId String 1

The ID of the host account.

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

The ID of the request, which is used to locate and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateHostAccount
&HostAccountName=abc
&HostId=1
&InstanceId=bastionhost-cn-st220aw****
&ProtocolName=SSH
&Password=****
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

HTTP status code Error code Error message Description
500 InternalError An unknown error occurred. The error message returned because an unknown error occurred.
400 InvalidParameter The argument is invalid. The error message returned because one or more parameters are invalid.
400 HostAccountAlreadyExists The host account already exists. The error message returned because the host account that you want to add to the host already exists.

For a list of error codes, visit the API Error Center.