1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
获取终端用户列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeEndUsers。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvId | 是 | String | 开发者的环境ID 示例值：envid |
| Offset | 否 | Integer | 可选参数，偏移量，默认 0 示例值：0 |
| Limit | 否 | Integer | 可选参数，拉取数量，默认 20 示例值：10 |
| UUIds.N | 否 | Array of String | 按照 uuid 列表过滤，最大个数为100 示例值：["00000000963b4a85a9b34e2d1fe0c685\n"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 用户总数 示例值：1 |
| Users | Array of EndUserInfo | 用户列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取终端用户列表
获取终端用户列表
输入示例
https://tcb.tencentcloudapi.com/?Action=DescribeEndUsers
&EnvId=envid
&UUIds.0=00000000963b4a85a9b34e2d1fe0c685
&<公共请求参数>输出示例
{
"Response": {
"Total": 1,
"Users": [
{
"UserName": "xx",
"QQOpenId": "xx",
"UpdateTime": "xx",
"UUId": "xx",
"AvatarUrl": "xx",
"Gender": "xx",
"IsDisabled": false,
"IsAnonymous": true,
"CreateTime": "xx",
"HasPassword": true,
"Phone": "xx",
"WXOpenId": "xx",
"NickName": "xx",
"Email": "xx"
}
],
"RequestId": "xx"
}
}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 | 参数错误。 |
| MissingParameter.Param | 缺少必要参数。 |
