CreateHostAccount - Bastionhost - Alibaba Cloud Documentation Center

After you create a host in Bastionhost, you can create a host account for the host. This brings an existing account on the host under the management of Bastionhost. After the host account is created, Operations and Maintenance (O&M) engineers can use the account to log on to the host through Bastionhost.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-bastionhost:CreateHostAccount

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance where you want to create the host account. Note Call the DescribeInstances operation to obtain the instance ID.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance where you want to create the host account. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
HostId	string	Yes	The ID of the host for which you want to create a host account. Note Call the ListHosts operation to obtain the host ID.	1
ProtocolName	string	Yes	The protocol of the new host account. Valid values: SSH RDP	SSH
HostAccountName	string	Yes	The name of the new host account. The name can be up to 128 characters long.	accountname
Password	string	No	The password of the new host account.	123456
PrivateKey	string	No	The private key of the new host account. The value is a Base64-encoded string. Note This parameter is used only when ProtocolName is set to SSH. You do not need to set this parameter if ProtocolName is set to RDP. You can set both a password and a private key for the host account. When connecting to the asset, Bastionhost prioritizes the private key for the connection.	LS0tLS1******RCBSU0tLQ==
PassPhrase	string	No	The passphrase for the private key of the new host account. Note You can set this parameter only when ProtocolName is set to SSH. You do not need to set this parameter if ProtocolName is set to RDP.	123456
HostShareKeyId	string	No	The ID of the shared key for the host.	1
PrivilegeType	string	No	The permission type of the account. If you do not set this parameter, the default value is Normal. Privileged: privileged account Normal: normal account Note This parameter is supported only in Bastionhost V3.2.47 and later.	Normal
RotationMode	string	No	The password change mode for the account. If you do not set this parameter, the default value is Self. Privileged: Use a privileged account to change the password. Self: Do not use a privileged account to change the password. Note This parameter is supported only in Bastionhost V3.2.47 and later.	Self

Response elements

Element	Type	Description	Example
	object
HostAccountId	string	The ID of the host account.	1
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
400	HostAccountAlreadyExists	The host account already exists.	The host account already exists.
500	InternalError	An unknown error occurred.	An unknown error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.