All Products
Search

This Product

    Bastionhost:ListHostAccountsForUser

    Document Center

    Bastionhost:ListHostAccountsForUser

    Last Updated:Jan 21, 2026

    Queries the host accounts of a host and whether a user is authorized to manage each 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:ListHostAccountsForUser

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the bastion host on which you want to perform the query. The host accounts that the specified user is authorized to manage on the specified host are queried.

    Note

    You can call the DescribeInstances operation to query the ID of the bastion host.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the bastion host on which you want to perform the query. The host accounts that the specified user is authorized to manage on the specified host are queried.

    Note

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

    cn-hangzhou
    UserId

    string

    Yes

    The ID of the user for which you want to query authorized host accounts.

    Note

    You can call the ListUsers operation to query the ID of the user.

    1
    HostId

    string

    Yes

    The ID of the host to query.

    Note

    You can call the ListHosts operation to query the ID of the host.

    1
    PageNumber

    string

    No

    The number of the page to return. Default value: 1.

    1
    PageSize

    string

    No

    The number of entries to return on each page.
    Maximum value: 100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

    Note

    We recommend that you do not leave this parameter empty.

    20
    HostAccountName

    string

    No

    The name of the host account that you want to query. Exact match is supported.

    root

    All Alibaba Cloud API requests 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 elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of host accounts that were queried.

    1
    RequestId

    string

    The ID of the request.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    HostAccounts

    array<object>

    An array that consists of the queried host accounts.

    object

    HostAccountName

    string

    The name of the host account.

    root
    HostAccountId

    string

    The ID of the host account.

    1
    IsAuthorized

    boolean

    Indicates whether the user is authorized to manage the host account. Valid values:

    • true: yes

    • false: no

    true
    ProtocolName

    string

    The protocol that is used by the host. Valid values:

    • SSH

    • RDP

    SSH
    HostId

    string

    The ID of the host for which the host accounts were queried.

    1

    Examples

    Success response

    JSON format

    {
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE ",
  "HostAccounts": [
    {
      "HostAccountName": "root",
      "HostAccountId": "1",
      "IsAuthorized": true,
      "ProtocolName": "SSH",
      "HostId": "1"
    }
  ]
}

    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.