Call the ListUserGroups API to query user groups - Bastionhost - Alibaba Cloud - Bastionhost

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

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance whose user groups you want to query. Note You can call the DescribeInstances operation to query the instance ID.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PageNumber	string	No	The page number for paging. Default value: 1.	1
PageSize	string	No	The maximum number of entries to return on each page for paging. Maximum value: 100. Default value: 20. If you leave this parameter empty, 20 entries are returned by default. Note Specify a value for this parameter.	20
UserGroupName	string	No	The name of the user group to query. Only exact match is supported.	TestGroup01
ProjectId	integer	No	The project ID.	3

When you call this operation, you must add the common request parameters of Alibaba Cloud API in addition to the request parameters described in this topic. For more information about common request parameters, see Common parameters. For the request format, see the sample request in this topic.

Response elements

Element	Type	Description	Example
	object	The response data.
TotalCount	integer	The total number of user groups returned.	1
RequestId	string	The ID of the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
UserGroups	array<object>	The user groups returned.
	object
UserGroupName	string	The name of the user group.	TestGroup01
MemberCount	integer	The number of users in the user group.	6
Comment	string	The description of the user group.	comment
UserGroupId	string	The ID of the user group.	1

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "UserGroups": [
    {
      "UserGroupName": "TestGroup01",
      "MemberCount": 6,
      "Comment": "comment",
      "UserGroupId": "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.