All Products
Search
Document Center

Bastionhost:ListHostsForUserGroup

Last Updated:Mar 01, 2024

Queries the hosts that a user group is authorized or not 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:ListHostsForUserGroupRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The category of the host that you want to query. Valid values:

  • Authorized: Query the hosts that the user group is authorized to manage. This is the default value.
  • Unauthorized: Query the hosts that the user group is not authorized to manage.
bastionhost-cn-st220aw****
RegionIdstringNo

The endpoint of the host that you want to query. You can set this parameter to a domain name or an IP address. Only exact match is supported.

cn-hangzhou
ModestringNo

The operating system of the host. Valid values:

  • Linux
  • Windows
Authorized
UserGroupIdstringYes

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

1
PageNumberstringNo

The endpoint type of the host. Valid values:

  • Public: a public endpoint
  • Private: an internal endpoint
1
PageSizestringNo

The number of entries to return on each page.

The value of the PageSize parameter must not exceed 100. Default value: 20. If you leave the PageSize parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave the PageSize parameter empty.
20
HostAddressstringNo

The operating system of the host that you want to query. Valid values:

  • Linux
  • Windows
192.168.XX.XX
HostNamestringNo

The ID of the Bastionhost instance where you want to query the hosts that the user group is authorized or not authorized to manage.

Note You can call the DescribeInstances operation to query the ID of the Bastionhost instance.
abc
OSTypestringNo

The internal endpoint of the host. The value is a domain name or an IP address.

Linux

The total number of hosts returned.

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The public endpoint of the host. The value is a domain name or an IP address.

10
RequestIdstring

The hosts returned.

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

The ID of the user group for which you want to query hosts.

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

The ID of the request.

comment
ActiveAddressTypestring

All Bastionhost 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.

Public
HostPublicAddressstring

Queries the hosts that a specified user group is authorized or not authorized to manage.

10.158.XX.XX
HostNamestring

ListHostsForUserGroup

host1
HostPrivateAddressstring

WB662865

192.168.XX.XX
OSTypestring

ListHostsForUserGroup

Linux

Examples

Sample success responses

JSONformat

{
  "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 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.