All Products
Search
Document Center

Bastionhost:ListHostAccountsForUserGroup

Last Updated:Apr 18, 2024

Queries the host accounts of the specified host that the specified user group is authorized to manage.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:ListHostAccountsForUserGroupRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host on which you want to query the host accounts to be managed by the specified user group on the specified host.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
bastionhost-cn-st220aw****
RegionIdstringNo

The region ID of the bastion host on which you want to query the host accounts to be managed by the specified user group on the specified host.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
UserGroupIdstringYes

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

Note You can call the ListUserGroups operation to query the ID of the user group.
1
HostIdstringYes

The ID of the host to query.

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

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

1
PageSizestringNo

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
HostAccountNamestringNo

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 parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of host accounts that were queried.

1
RequestIdstring

The ID of the request.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccountsobject []

An array that consists of the queried host accounts.

HostAccountNamestring

The name of the host account.

host1
HostAccountIdstring

The ID of the host account.

1
IsAuthorizedboolean

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

  • true: yes
  • false: no
true
ProtocolNamestring

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

  • SSH
  • RDP
SSH
HostIdstring

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the Service error codes.