ListHostGroupsForUser - Bastionhost - Alibaba Cloud Documentation Center

Queries the host groups that a specified user 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.

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:ListHostGroupsForUser	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The host groups returned.	bastionhost-cn-st220aw****
RegionId	string	No	The number of the page to return. Default value: 1.	cn-hangzhou
Mode	string	No	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.	Authorized
UserId	string	Yes	The ID of the Bastionhost instance where you want to query the host groups that the user is authorized or not authorized to manage. Note You can call the DescribeInstances operation to query the ID of the Bastionhost instance.	１
PageNumber	string	No	The ID of the host group.	１
PageSize	string	No	The ID of the user. Note You can call the ListUsers operation to query the ID of the user.	20
HostGroupName	string	No	The ID of the request.	group

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

Authorized: Query the host groups that the user is authorized to manage. This is the default value.
Unauthorized: Query the host groups that the user is not authorized to manage.

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	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.	1
RequestId	string	Queries the host groups that a specified user is authorized or not authorized to manage.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostGroups	object []	ListHostGroupsForUser
HostGroupId	string	WB662865	１
Comment	string	ListHostGroupsForUser	comment

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostGroups": [
    {
      "HostGroupId": "１",
      "Comment": "comment",
      "HostGroupName": "group"
    }
  ]
}

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.