All Products
Search
Document Center

Bastionhost:ListHostGroups

Last Updated:Sep 19, 2024

Queries a list of asset groups that are managed by a bastion host.

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:ListHostGroupsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host to query.

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

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
PageNumberstringNo

The page number. Default value: 1.

1
PageSizestringNo

The number of entries per page. Valid values: 1 to 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
HostGroupNamestringNo

The name of the host group that you want to query. Only exact match is supported.

Host group 1

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of asset groups returned.

1
RequestIdstring

The request ID.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostGroupsarray<object>

The asset groups returned.

object
MemberCountinteger

The number of hosts in the asset group.

1
HostGroupIdstring

The asset group ID.

1
Commentstring

The remarks of the asset group.

Description
HostGroupNamestring

The name of the asset 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

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.