1. 接口描述
接口请求域名： ioa.tencentcloudapi.com 。
获取账号列表，支持分页，模糊搜索，私有化调用path为：/capi/Assets/Account/DescribeLocalAccounts
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeLocalAccounts。 |
| Version | 是 | String | 公共参数，本接口取值：2022-06-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Condition | 否 | Condition | 查询条件：过滤或排序 1、UserName，string类型，姓名 是否必填：否 过滤支持：是，支持eq、like、ilike 排序支持：否 2、UserId，string类型，账户 是否必填：否 过滤支持：是，支持eq、like、ilike 排序支持：否 3、Phone，string类型，手机号 是否必填：否 过滤支持：是，支持eq、like、ilike 排序支持：否 示例值：{ "FilterGroups": [ { "Filters": [ { "Field": "UserId", "Operator": "ilike", "Values": [ "weiwang" ] } ] } ], "PageNum": 1, "PageSize": 10 } |
| AccountGroupId | 否 | Integer | 获取账号的分组ID，不传默认获取全网根账号组 示例值：249973 |
| ShowFlag | 否 | Integer | 是否仅展示当前目录下用户 1： 递归显示 2：仅显示当前目录下用户 示例值：2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeLocalAccountsPage | 获取账号列表响应的分页对象 示例值：复杂类型，示例参考接口示例部分 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据账号模糊查询
查询指定分组下，账号名包含“san47”的账号信息
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLocalAccounts
<公共请求参数>
{
"Condition": {
"Filters": [
{
"Field": "UserId",
"Operator": "like",
"Values": [
"san47"
]
}
]
},
"AccountGroupId": 8205,
"ShowFlag": 1
}输出示例
{
"Response": {
"Data": {
"Items": [
{
"AccountGroups": [],
"AccountId": 845,
"ActiveStatus": 0,
"ExtraInfo": "{\"salt\": \"5b52ea107e85a7b46d2c1b15a5faf722\", \"seat\": \"\", \"email\": \"\", \"phone\": \"\", \"is_new\": 0, \"id_card\": \"\", \"user_id\": \"zhangsan471\", \"password\": \"82a4c5b9e0e8bc57208e27ca08d090739ca02725b3bc9a282a8a95925e484cd6\", \"position\": \"测试248\", \"user_name\": \"zhangsan\", \"online_num\": 0, \"valid_time\": \"2030-10-10 00:00:00\", \"gesture_pwd\": \"\", \"is_modified\": 0, \"miniIAM_guid\": \"\", \"is_online_num\": 0, \"is_valid_time\": 1, \"valid_time_int\": 1917792000, \"iam_disable_account\": 0, \"ioa_disable_account\": 0}",
"GroupId": 8205,
"GroupName": "研发部",
"Id": 845,
"Itime": "2024-08-02 14:46:11",
"LoginTime": "2024-08-03 15:06:09",
"LogoutTime": "2024-08-03 18:01:09",
"MobileBindNum": 0,
"NamePath": "全网账户.自建目录.研发部",
"OnlineStatus": 0,
"PcBindNum": 0,
"RiskLevel": "low",
"Source": 0,
"Status": 1,
"UserId": "zhangsan471",
"UserName": "zhangsan",
"Utime": "2024-08-03 15:08:21"
},
{
"AccountGroups": [],
"AccountId": 844,
"ActiveStatus": 0,
"ExtraInfo": "{\"salt\": \"2d6cfa9479b615ce807305f727f55757\", \"seat\": \"\", \"email\": \"\", \"phone\": \"\", \"is_new\": 0, \"id_card\": \"\", \"user_id\": \"zhangsan470\", \"password\": \"608f9eac835f474f8e8eb43d3e4f9fbe675f467f25765655aa42926258a7c963\", \"position\": \"测试247\", \"user_name\": \"zhangsan\", \"online_num\": 0, \"valid_time\": \"2030-10-10\", \"gesture_pwd\": \"\", \"is_modified\": 0, \"miniIAM_guid\": \"\", \"is_online_num\": 0, \"is_valid_time\": 1, \"valid_time_int\": 1917792000, \"iam_disable_account\": 0, \"ioa_disable_account\": 0}",
"GroupId": 8205,
"GroupName": "研发部",
"Id": 844,
"Itime": "2024-08-02 14:46:11",
"LoginTime": "2024-09-03 06:56:09",
"LogoutTime": "2024-09-03 15:06:07",
"MobileBindNum": 0,
"NamePath": "全网账户.自建目录.研发部",
"OnlineStatus": 0,
"PcBindNum": 0,
"RiskLevel": "low",
"Source": 0,
"Status": 1,
"UserId": "zhangsan470",
"UserName": "zhangsan",
"Utime": "2024-08-02 14:46:11"
}
],
"Page": {
"PageCount": 1,
"PageNum": 1,
"PageSize": 10,
"Total": 2
}
},
"RequestId": "ed2c6d00-8880-4a2a-8d6d-e89587dc5a21"
}
}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.DatabaseException | 内部错误，数据库异常。 |
| InvalidParameter.RequestParam | 请求参数错误。 |
