ListHostGroups - Bastionhost - Alibaba Cloud Documentation Center

Queries host groups in a specified bastion host.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:ListHostGroups	List	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host in which you want to query the host group. 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 in which you want to query the host group. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
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
HostGroupName	string	No	The name of the host group that you want to query. Only exact match is supported.	Host group 1

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

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of host groups returned.	1
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostGroups	object []	An array that consists of the host groups.
MemberCount	integer	The number of hosts in the host group.	1
HostGroupId	string	The ID of the host group.	1
Comment	string	The description of the host group.	Description
HostGroupName	string	The name of the host group.	Host group 1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostGroups": [
    {
      "MemberCount": 1,
      "HostGroupId": "1",
      "Comment": "Description\n",
      "HostGroupName": "Host group 1\n"
    }
  ]
}

Error codes

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