All Products
Search

This Product

    Bastionhost:CreateHostAccount

    Document Center

    Bastionhost:CreateHostAccount

    Last Updated:Aug 11, 2026

    After you create a host in Bastionhost, you can create a host account for the host to manage the existing account of the host in Bastionhost. After you create a host account, O&M engineers can use the account to log on to the host through Bastionhost for O&M operations.

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the Bastionhost instance where the host for which you want to create a host account resides.

    Note

    You can call the DescribeInstances operation to query the Bastionhost instance ID.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the Bastionhost instance where the host for which you want to create a host account resides.

    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

    You can call the ListHosts operation to query this parameter.

    1
    ProtocolName

    string

    Yes

    The protocol name of the host account to create.
    Valid values:

    • SSH

    • RDP

    SSH
    HostAccountName

    string

    Yes

    The name of the host account to create. The name can be up to 128 characters in length.

    accountname
    Password

    string

    No

    The password of the host account to create.

    123456
    PrivateKey

    string

    No

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

    Note

    This parameter takes effect only when ProtocolName is set to SSH. You do not need to configure this parameter when ProtocolName is set to RDP. You can configure both a password and a private key for the host account. When connecting to an asset, Bastionhost preferentially uses the private key.

    LS0tLS1******RCBSU0tLQ==
    PassPhrase

    string

    No

    The passphrase of the private key for the host account to create.

    Note

    You can configure this parameter when ProtocolName is set to SSH. You do not need to configure this parameter when ProtocolName is set to RDP.

    123456
    HostShareKeyId

    string

    No

    The ID of the shared key for the host.

    1
    PrivilegeType

    string

    No

    The privilege type of the account. Default value: Normal.

    • Privileged: privileged account.

    • Normal: standard account.

    Note

    Only supported in V3.2.47 and later.

    Normal
    RotationMode

    string

    No

    The password rotation mode of the account. Default value: Self.

    • Privileged: uses a privileged account to rotate the password.

    • Self: does not use a privileged account to rotate the password.

    Note

    Only supported in V3.2.47 and later.

    Self

    No

    The project ID.

    Response elements

    Element

    Type

    Description

    Example

    object

    HostAccountId

    string

    The ID of the host account.

    1
    RequestId

    string

    The request ID.

    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.