All Products
Search

This Product

    Bastionhost:RemoveUsersFromGroup

    Document Center

    Bastionhost:RemoveUsersFromGroup

    Last Updated:Feb 11, 2026

    Removes one or more users from a user group.

    Operation description

    You can call this operation to remove one or more users from a user group. When users in a user group are transferred to a new position, resign, or are switched to another user group, you can call this operation to remove the users from the current user group at a time.

    QPS limit

    You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

    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

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the bastion host for which you want to remove users from the user group.

    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 for which you want to remove users from the user group.

    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 ID of the user group.

    １
    UserIds

    string

    Yes

    The ID of the user who you want to remove. The value is a JSON string. You can add up to 100 user IDs. If you specify multiple IDs, separate the IDs with commas (,).

    Note

    You can call the ListUsers operation to query the IDs of users.

    ["1","2","3"]

    All Alibaba Cloud API operations 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.

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request, which is used to locate and troubleshoot issues.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    Results

    array<object>

    The result of the call.

    object

    Code

    string

    The return code that indicates whether the call was successful. Valid values:

    • OK: The call was successful.

    • UNEXPECTED: An unknown error occurred.

    • INVALID_ARGUMENT: A request parameter is invalid.

    Note

    Make sure that the request parameters are valid and call the operation again.

    • OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist.

    Note

    Check whether the specified ID of the bastion host exists, whether the specified hosts exist, and whether the specified host IDs are valid. Then, call the operation again.

    • OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.

    OK
    Message

    string

    This parameter is deprecated.

    None
    UserGroupId

    string

    The ID of the 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.