All Products
Search

This Product

    Bastionhost:ModifyHostAccount

    Document Center

    Bastionhost:ModifyHostAccount

    Last Updated:Feb 02, 2026

    Modifies host account information, including the name, password, and private key of the host account.

    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:ModifyHostAccount

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    Specifies the ID of the Bastionhost instance where the host account to be modified resides.

    Note

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

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    Specifies the region ID of the Bastionhost instance where the host account to be queried resides.

    Note

    For the mapping between region IDs and region names, see Regions and zones.

    cn-hangzhou
    HostAccountId

    string

    Yes

    Specifies the ID of the host account to be modified.

    Note

    You can call the ListHostAccounts operation to obtain this parameter.

    1
    HostAccountName

    string

    No

    Specifies the modified host account name, which can contain up to 128 characters.

    abc
    Password

    string

    No

    Specifies the modified password of the host account.

    123456
    PrivateKey

    string

    No

    Specifies the modified private key of the host account, which is a Base64-encoded string.

    Note

    This parameter takes effect when the host account protocol is SSH. This parameter is not required when the host account protocol is RDP. You can call the GetHostAccount operation to query the protocol used by the host account. You can configure both a password and a private key for a host account. When connecting to an asset, Bastionhost preferentially uses the private key for connection.

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

    PassPhrase

    string

    No

    Specifies the modified security token of the host account's private key.

    Note

    This parameter takes effect when the host account protocol is SSH. This parameter is not required when the host account protocol is RDP.

    123456
    HostShareKeyId

    string

    No

    The host shared key ID.

    Note

    You can obtain this ID by calling the ListHostShareKeys operation.

    1
    PrivilegeType

    string

    No

    Account permission type. Valid values:

    • Privileged: privileged account

    • Normal: regular account

    Note

    This parameter is supported only in V3.2.47 and later versions.

    Normal
    RotationMode

    string

    No

    Account password rotation mode. Valid values:

    • 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 V3.2.47 and later versions.

    Self

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique ID generated by Alibaba Cloud for this request.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    Examples

    Success response

    JSON format

    {
  "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.
    500 InternalError An unknown error occurred. An unknown error occurred.
    404 HostAccountNotFound The host account is not found. The host account is not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.