1. 接口描述
接口请求域名： dasb.tencentcloudapi.com 。
查询用户列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUsers。 |
| Version | 是 | String | 公共参数，本接口取值：2019-10-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| IdSet.N | 否 | Array of Integer | 如果IdSet不为空，则忽略其他参数 示例值：[1,2] |
| Name | 否 | String | 模糊查询，IdSet、UserName、Phone为空时才生效，对用户名和姓名进行模糊查询 示例值：zhangsan |
| Offset | 否 | Integer | 分页偏移位置，默认值为0 示例值：0 |
| Limit | 否 | Integer | 每页条目数量，默认20, 最大500 示例值：10 |
| UserName | 否 | String | 精确查询，IdSet为空时才生效 示例值：张三 |
| Phone | 否 | String | 精确查询，IdSet、UserName为空时才生效。 大陆手机号直接填写，如果是其他国家、地区号码,按照"国家地区代码|手机号"的格式输入。如: "+852|xxxxxxxx" 示例值：13112341234 |
| 否 | String | 邮箱，精确查询 示例值：123**@qq.com |
|
| AuthorizedDeviceIdSet.N | 否 | Array of Integer | 查询具有指定资产ID访问权限的用户 示例值：[1,2] |
| AuthTypeSet.N | 否 | Array of Integer | 认证方式，0 - 本地, 1 - LDAP, 2 - OAuth, 不传为全部 示例值：[0,1] |
| DepartmentId | 否 | String | 部门ID，用于过滤属于某个部门的用户 示例值：1.2.3 |
| Filters.N | 否 | Array of Filter | 参数过滤数组 示例值：[{"Name":"InstanceId", “Values":["ins-saawadas"]}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 用户总数 示例值：2 |
| UserSet | Array of User | 用户列表 示例值：[{"Id":58}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户列表
查询用户列表
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsers
<公共请求参数>
{}输出示例
{
"Response": {
"TotalCount": 1,
"UserSet": [
{
"UserName": "zhangsan",
"AuthType": 1,
"ValidateTo": "2020-09-22T00:00:00+00:00",
"RealName": "张三",
"ValidateTime": "2020-09-23T00:00:00+00:00",
"Email": "xxx@qq.com",
"Phone": "+86|135**11",
"GroupSet": [
{
"Department": {
"Managers": [
"152017423"
],
"Id": "1.2",
"Name": "研发部"
},
"Id": 1,
"Name": "运维组",
"Count": 1
}
],
"Department": {
"Managers": [
"152017423"
],
"Id": "1.2",
"Name": "研发部"
},
"ValidateFrom": "2020-09-22T00:00:00+00:00",
"Id": 1,
"DepartmentId": "1.2"
}
],
"RequestId": "cf839eee-b651-4ff3-9b49-173f9f55733f"
}
}示例2 根据主机查询有访问权限的用户信息
根据主机查询有访问权限的用户信息
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsers
<公共请求参数>
{
"AuthorizedDeviceIdSet": [
63,
64,
82,
100
],
"Name": "zhangsan"
}输出示例
{
"Response": {
"TotalCount": 1,
"UserSet": [
{
"UserName": "zhangsan",
"AuthType": 1,
"ValidateTo": "2020-09-22T00:00:00+00:00",
"RealName": "张三",
"ValidateTime": "2020-09-23T00:00:00+00:00",
"Email": "xxx@tencent.com",
"Phone": "+86|135**11",
"GroupSet": [
{
"Department": {
"Managers": [
"152017423"
],
"Id": "1.2",
"Name": "研发部"
},
"Id": 1,
"Name": "运维组",
"Count": 1
}
],
"Department": {
"Managers": [
"152017423"
],
"Id": "1.2",
"Name": "研发部"
},
"ValidateFrom": "2020-09-22T00:00:00+00:00",
"Id": 1,
"DepartmentId": "1.2"
}
],
"RequestId": "cf839eee-b651-4ff3-9b49-173f9f55733f"
}
}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 | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
