All Products
Search

This Product

    Bastionhost:GetHostAccount

    Document Center

    Bastionhost:GetHostAccount

    Last Updated:Jan 21, 2026

    Retrieves the details of a specified 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:GetHostAccount

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the Bastionhost instance where the host account that you want to query resides.

    Note

    You can call the DescribeInstances operation to obtain this parameter.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the Bastionhost instance where the host account that you want to query resides.

    Note

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

    cn-hangzhou
    HostAccountId

    string

    Yes

    The ID of the host account that you want to query.

    Note

    You can call the ListHostAccounts operation to obtain this parameter.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    The response data.

    RequestId

    string

    The unique identifier generated by Alibaba Cloud for the request.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    HostAccount

    object

    The detailed information about the queried host account.

    HasPassword

    boolean

    Indicates whether a password is set for the host account. Valid values:

    • true: A password is set.

    • false: No password is set.

    true
    PrivateKeyFingerprint

    string

    The fingerprint information of the private key.

    fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**
    ProtocolName

    string

    The protocol name of the host account. Valid values:

    • SSH

    • RDP

    SSH
    HostAccountName

    string

    The name of the host account.

    abc
    HostAccountId

    string

    The ID of the host account.

    1
    HostId

    string

    The ID of the host to which the host account belongs.

    1
    HostShareKeyId

    string

    The ID of the shared key for the host.

    1
    RotationMode

    string

    The password rotation mode of the account.

    • Privileged: Use a privileged account to rotate passwords

    • Self: Do not use a privileged account to rotate passwords

    Note

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

    Privileged
    HostShareKeyName

    string

    The name of the shared key for the host.

    name
    PrivilegeType

    string

    The permission type of the account.

    • Privileged: Privileged account

    • Normal: Regular account

    Note

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

    Normal

    Examples

    Success response

    JSON format

    {
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccount": {
    "HasPassword": true,
    "PrivateKeyFingerprint": "fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**",
    "ProtocolName": "SSH",
    "HostAccountName": "abc",
    "HostAccountId": "1",
    "HostId": "1",
    "HostShareKeyId": "1",
    "RotationMode": "Privileged",
    "HostShareKeyName": "name",
    "PrivilegeType": "Normal"
  }
}

    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.