1. 接口描述
接口请求域名: dasb.tencentcloudapi.com 。
查询用户组成员列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeUserGroupMembers。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Id | 是 | Integer | 用户组ID 示例值:1 |
Bound | 是 | Boolean | true - 查询已添加到该用户组的用户,false - 查询未添加到该用户组的用户 示例值:true |
Name | 否 | String | 用户名或用户姓名,最长64个字符,模糊查询 示例值:运营组 |
Offset | 否 | Integer | 分页偏移位置,默认值为0 示例值:0 |
Limit | 否 | Integer | 每页条目数量,默认20, 最大500 示例值:10 |
DepartmentId | 否 | String | 所属部门ID 示例值:1.2.3 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 用户组成员总数 示例值:2 |
UserSet | Array of User | 用户组成员列表 示例值:[{"Id":10}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户组成员列表
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserGroupMembers
<公共请求参数>
{
"Id": 1,
"Name": "张三",
"Bound": true,
"Offset": 1,
"Limit": 1,
"DepartmentId": "1.4"
}
输出示例
{
"Response": {
"TotalCount": 1,
"UserSet": [
{
"UserName": "Aiden",
"AuthType": 1,
"ValidateTo": "2020-09-22T00:00:00+08:00",
"RealName": "Henry",
"ValidateTime": "2020-09-22T00:00:00+08:00",
"Email": "245***106@163.com",
"Phone": "177****4532",
"GroupSet": [
{
"Department": {
"Managers": [
"457824365"
],
"Id": "10",
"Name": "测试组"
},
"Id": 1,
"Name": "开发组",
"Count": 1
}
],
"DepartmentId": "1.5",
"Department": {
"Managers": [
"15478952664"
],
"Id": "231",
"Name": "测试组"
},
"ValidateFrom": "2020-09-22T00:00:00+00:00",
"Id": 1
}
],
"RequestId": "557246f9-3ee4-406d-8c36-6885e2ae52d9"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DataNotFound | 目标数据不存在。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
UnsupportedOperation | 操作不支持。 |