1. 接口描述
接口请求域名: eiam.tencentcloudapi.com 。
从用户组中移除用户
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
本文档展示的是V1签名的参数说明,腾讯云建议您使用安全系数更高的V3签名算法,使用签名方法 v3 时,公共参数需要统一放到 HTTP Header 请求头部中,详情。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RemoveUserFromUserGroup。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-20。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
UserIds.N | 是 | Array of String | 要加入用户组的用户ID列表。 |
UserGroupId | 是 | String | 用户组ID,是用户组的全局唯一标识。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: eiam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RemoveUserFromUserGroup
<公共请求参数>
{
"UserIds": [
"3945dcb0-e433-4fd0-a69b-b5074abe3cbd"
],
"UserGroupId": "1453013c-d0e9-424b-b9c7-dabcea3bd0ca"
}
输出示例
{
"Response": {
"RequestId": "fb35b3c9-ea28-4e9a-b6f4-c02f1e0bc399"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.GroupIdNotFound | 用户组ID未找到。 |
FailedOperation.OperationError | 操作失败。 |
FailedOperation.PersonNotFound | 身份主体未找到。 |
FailedOperation.RemoveUsersFromUserGroupError | 从用户组中移除用户失败。 |
FailedOperation.UserNotExistInUserGroup | 用户不存在于该用户组。 |
InvalidParameter.Parameterlllegal | 参数不合法。 |
InvalidParameterValue.ParameterIllegal | 参数不合法。 |