Use RemoveUsersFromGroup to remove users from a user group - Bastionhost - Alibaba Cloud - Bastionhost

Operation description

Usage notes

This operation removes multiple users from a user group. You can call this operation to remove users from a user group in batches when users resign or transfer to other departments and their permissions need to be revoked, or when users switch to another user group.

QPS limits

The QPS limit for a single user is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make API calls at a reasonable rate.

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

delete

*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 to which the user group from which you want to remove users belongs. Note You can call the DescribeInstances operation to query the value of this parameter.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance to which the user group from which you want to remove users belongs. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
UserGroupId	string	Yes	The ID of the user group from which you want to remove users. Note You can call the ListUserGroups operation to query the value of this parameter.	１
UserIds	string	Yes	The IDs of the users that you want to remove. The value of this parameter is a JSON string. You can specify up to 100 user IDs. Separate multiple IDs with commas (,). Note You can call the ListUsers operation to query user IDs.	["1","2","3"]
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 more information about the request format, see the sample request in this topic.

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request. The ID is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	The result information of the operation.
	object
Code	string	The result of the operation. Valid values: OK: The operation is successful. UNEXPECTED: An unknown error occurred. INVALID_ARGUMENT: A request parameter is invalid. Note Check the request parameters and make sure that the parameters are valid before you call the operation again. OBJECT_NOT_FOUND: The object on which you want to perform the operation does not exist. Note Check whether the ID of the Bastionhost instance exists, whether the host exists, and whether the host ID is correct, and then call the operation again. OBJECT_AlREADY_EXISTS: The object on which you want to perform the operation already exists.	OK
Message	string	[Deprecated] This parameter is deprecated and can be ignored.	None
UserGroupId	string	The ID of the user group.	1
UserId	string	The ID of the user.	1

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "None",
      "UserGroupId": "1",
      "UserId": "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.