ListUserGroups - Bastionhost - Alibaba Cloud Documentation Center

Queries a list of user groups on a bastion host.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListUserGroups	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host on which you want to query user groups. 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 on which you want to query user groups. 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.	20
UserGroupName	string	No	The name of the user group that you want to query. Only exact match is supported.	TestGroup01

Response parameters

Parameter	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.
Item	object
UserGroupName	string	The name of the user group.	TestGroup01
MemberCount	integer	The number of users in the user group.	5
Comment	string	The description of the user group.	comment
UserGroupId	string	The ID of the user group.	1

Examples

Sample success responses

JSONformat

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

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