调用RemoveUsersFromGroup接口批量移除用户组内用户。

使用说明

本接口用于批量移除用户组内的用户。当用户离职或转岗您要回收用户权限,或者用户切换用户组时,可使用本接口将涉及权限变动的用户从用户组内批量移除。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String RemoveUsersFromGroup

需要执行的操作。

取值:RemoveUsersFromGroup

InstanceId String bastionhost-cn-st220aw****

要移除用户的用户组所在堡垒机实例的ID。

说明 您可以调用DescribeInstances接口获取该参数。
UserGroupId String

要移除用户的用户组的ID。

说明 您可以调用ListUserGroups接口获取该参数。
UserIds String ["1","2","3"]

要移除的用户的ID。以该参数为JSON格式的字符串,最多支持设置100个用户ID,多个ID之间使用半角逗号(,)隔开。

说明 您可以调用ListUsers接口获取用户ID。
RegionId String cn-hangzhou

要移除用户的用户组所在堡垒机的地域ID。

说明 地域ID和地域名称的对应关系,请参见地域和可用区

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

Results Array of Item

接口的调用结果信息。

Code String OK

接口调用的结果。取值:

  • OK:操作成功。
  • UNEXPECTED:未知错误。
  • INVALID_ARGUMENT:请求参数设置错误。
    说明 请检查请求参数,确保参数正确后重新调用接口。
  • OBJECT_NOT_FOUND:操作的对象不存在。
    说明 请检查该堡垒机实例的ID是否存在,主机是否存在,主机ID是否填写正确,然后重新调用接口。
  • OBJECT_AlREADY_EXISTS :操作的对象已存在。
Message String

该参数已废弃,无需关注。

UserGroupId String 1

用户组的ID。

UserId String 1

用户的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=RemoveUsersFromGroup
&InstanceId=bastionhost-cn-st220aw****
&UserGroupId=1
&UserIds=["1","2","3"]
&<公共请求参数>

正常返回示例

XML格式

<RemoveUsersFromGroupResponse>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <Results>
            <Message></Message>
            <Code>OK</Code>
            <UserId>1</UserId>
            <UserGroupId>1</UserGroupId>
      </Results>
</RemoveUsersFromGroupResponse>

JSON格式

{
	"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
	"Results": [{
		"Message": "",
		"Code": "OK",
		"UserId": "1",
		"UserGroupId": "1"
	}]
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An unknown error occurred. 未知错误
400 InvalidParameter The argument is invalid. 参数错误

访问错误中心查看更多错误码。