接口请求域名: tcsas.intl.tencentcloudapi.com 。
查询用户列表
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeUserList。 |
| Version | 是 | String | 公共参数,本接口取值:2025-01-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Offset | 是 | Integer | 分页的偏移量 |
| Limit | 是 | Integer | 分页的条数 |
| PlatformId | 是 | String | 平台ID |
| Keyword | 否 | String | 查询关键字(用户名或者账号) |
| AccountType | 否 | Integer | 用户账号 1-超级管理员 2-平台管理员 3-普通成员,不传表示全部 |
| TeamId | 否 | String | 团队ID,不传表示全部 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeUserListResp | 响应数据 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tcsas.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserList
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"PlatformId": "T08123WM5791733VNCZ",
"Keyword": "mini",
"AccountType": 3,
"TeamId": "1151697965"
}
{
"Response": {
"Data": {
"DataList": [
{
"AccountType": 3,
"CreateTime": "1733800355",
"Status": 1,
"TeamName": "murphypeng_mini",
"UserAccount": "murphypeng_app_mini",
"UserId": "U20241210111235IUXUVE",
"UserName": "murphypeng_app_mini"
},
{
"AccountType": 3,
"CreateTime": "1733800326",
"Status": 1,
"TeamName": "murphypeng_mini",
"UserAccount": "murphypeng_mini",
"UserId": "U20241210111206CSCDKP",
"UserName": "murphypeng_mini"
}
],
"TotalCount": 2
},
"RequestId": "4be87bb6-bb55-4c57-89fe-6ad6a3b11b83"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.PackageAlreadyExpired | FailedOperation.PackageAlreadyExpired |
| InvalidParameterValue.InvalidAccountType | InvalidParameterValue.InvalidAccountType |
| InvalidParameterValue.InvalidTeamId | InvalidParameterValue.InvalidTeamId |
文档反馈