批量移除用户组内用户。
接口说明
使用说明
本接口用于批量移除用户组内的用户。当用户离职或转岗您要回收用户权限,或者用户切换用户组时,可使用本接口将涉及权限变动的用户从用户组内批量移除。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-bastionhost:RemoveUsersFromGroup |
delete |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
要移除用户的用户组所在堡垒机实例的 ID。 说明
您可以调用 DescribeInstances 接口获取该参数。 |
bastionhost-cn-st220aw**** |
| RegionId |
string |
否 |
要移除用户的用户组所在堡垒机的地域 ID。 说明
地域 ID 和地域名称的对应关系,请参见地域和可用区。 |
cn-hangzhou |
| UserGroupId |
string |
是 |
要移除用户的用户组的 ID。 说明
您可以调用 ListUserGroups 接口获取该参数。 |
1 |
| UserIds |
string |
是 |
要移除的用户的 ID。以该参数为 JSON 格式的字符串,最多支持设置 100 个用户 ID,多个 ID 之间使用半角逗号(,)隔开。 说明
您可以调用 ListUsers 接口获取用户 ID。 |
["1","2","3"] |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。 调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应数据。 |
||
| RequestId |
string |
本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
| Results |
array<object> |
接口的调用结果信息。 |
|
|
object |
|||
| Code |
string |
接口调用的结果。取值:
|
OK |
| Message |
string |
该参数已废弃,无需关注。 |
无 |
| UserGroupId |
string |
用户组的 ID。 |
1 |
| UserId |
string |
用户的 ID。 |
1 |
示例
正常返回示例
JSON格式
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"Results": [
{
"Code": "OK",
"Message": "无",
"UserGroupId": "1",
"UserId": "1"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | 参数错误 |
| 500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。