1. 接口描述
接口请求域名： cme.tencentcloudapi.com 。
获取指定团队的成员信息。支持获取指定成员的信息，同时也支持分页拉取指定团队的所有成员信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTeamMembers。 |
| Version | 是 | String | 公共参数，本接口取值：2019-10-29。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Platform | 是 | String | 平台 Id，指定访问的平台。关于平台概念，请参见文档 平台。 示例值：test |
| TeamId | 是 | String | 团队 ID。 示例值：1kdk882ddd88338ddd3k3 |
| MemberIds.N | 否 | Array of String | 成员 ID 列表，限指定30个指定成员。如不填，则返回指定团队下的所有成员。 |
| Offset | 否 | Integer | 分页偏移量，默认值：0 示例值：0 |
| Limit | 否 | Integer | 返回记录条数，默认值：30，最大值：30。 示例值：10 |
| Operator | 否 | String | 操作者。如不填，默认为 cmeid_system，表示平台管理员操作，可以拉取任意团队成员的信息。如果指定操作者，则操作者必须为团队成员。示例值：60097a8a8ea83d00017b484b |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的记录总数。 示例值：30 |
| MemberSet | Array of TeamMemberInfo | 团队成员列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取指定成员的信息
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTeamMembers
<公共请求参数>
{
"Platform": "test",
"TeamId": "1kdk882ddd88338ddd3k3",
"MemberIds": [
"1993939392iidkei8ei"
]
}输出示例
{
"Response": {
"TotalCount": 1,
"MemberSet": [
{
"MemberId": "1993939392iidkei8ei",
"Remark": "主编辑李四",
"Role": "Members"
}
],
"RequestId": "99004d9f-aeec-4817-bbe2-d3499f95a2bf"
}
}示例2 分页拉取团队成员信息
输入示例
POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTeamMembers
<公共请求参数>
{
"Platform": "test",
"TeamId": "1kdk882ddd88338ddd3k3",
"Limit": "10",
"Offset": "0"
}输出示例
{
"Response": {
"TotalCount": 3,
"MemberSet": [
{
"MemberId": "299addf39392iidkei38",
"Remark": "主编辑李四",
"Role": "Owner"
},
{
"MemberId": "39a39a9b92iidkei9ab",
"Remark": "主编辑李四",
"Role": "Admin"
},
{
"MemberId": "i9dlld9393d2iidkei89i0",
"Remark": "主编辑李四",
"Role": "Members"
}
],
"RequestId": "99004d9f-aeec-4817-bbe2-d3499f95a2bf"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.Platform | 平台参数非法。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Limit | 返回记录条数不合法。 |
| InvalidParameterValue.Offset | 分页偏移不合法。 |
| InvalidParameterValue.Platform | 平台参数取值错误。 |
| InvalidParameterValue.TeamNotExist | 团队不存在。 |
| OperationDenied.PermissionDeny | 权限不足，请检查对应操作者的权限。 |
| ResourceNotFound.Platform | 平台不存在。 |
| UnauthorizedOperation | 未授权操作。 |
