All Products
Search

This Product

    Bastionhost:ListHostsForUserGroup

    Document Center

    Bastionhost:ListHostsForUserGroup

    Last Updated:Jun 08, 2026

    Lists the authorized or unauthorized hosts for a bastion host user group.

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

    get

    *Instance

    acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the bastion host instance that contains the user group.

    Note

    You can call the DescribeInstances operation to obtain the instance ID.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The ID of the region where the bastion host instance is located.

    Note

    For more information about regions and their corresponding IDs, see regions and availability zones.

    cn-hangzhou
    Mode

    string

    No

    Specifies whether to query for authorized or unauthorized hosts. Valid values:

    • Authorized (default)

    • Unauthorized

    Authorized
    UserGroupId

    string

    Yes

    The ID of the user group whose hosts you want to list.

    Note

    You can call the ListUserGroups operation to obtain the user group ID.

    1
    PageNumber

    string

    No

    The page 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.

    Note

    We recommend that you specify this parameter.

    20
    HostAddress

    string

    No

    The address of the host. You can set this parameter to a domain name or an IP address. Exact match is supported.

    192.168.XX.XX
    HostName

    string

    No

    The name of the host. Exact match is supported.

    abc
    OSType

    string

    No

    The operating system of the host. Valid values:

    • Linux

    • Windows

    Linux

    In addition to API-specific parameters, requests must include the common request parameters for Alibaba Cloud APIs. See common parameters for a detailed description and the request example in this topic for the request format.

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    TotalCount

    integer

    The total number of hosts.

    10
    RequestId

    string

    The ID of the request.

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

    array<object>

    A list of hosts.

    object

    The information about the host.

    Comment

    string

    The remarks of the host.

    comment
    ActiveAddressType

    string

    The address type of the host. Valid values:

    • Public: a public IP address

    • Private: a private IP address

    Public
    HostPublicAddress

    string

    The public IP address of the host. This can be a domain name or an IP address.

    10.158.XX.XX
    HostName

    string

    The name of the host.

    host1
    HostPrivateAddress

    string

    The private IP address of the host. This can be a domain name or an IP address.

    192.168.XX.XX
    OSType

    string

    The OS type of the host. Valid values:

    • Linux

    • Windows

    Linux
    HostId

    string

    The ID of the host.

    1

    Examples

    Success response

    JSON format

    {
  "TotalCount": 10,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Hosts": [
    {
      "Comment": "comment",
      "ActiveAddressType": "Public",
      "HostPublicAddress": "10.158.XX.XX",
      "HostName": "host1",
      "HostPrivateAddress": "192.168.XX.XX",
      "OSType": "Linux",
      "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.