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 | 滤条件、分页参数 |
AccountGroupId | 否 | Integer | 获取账号的分组Id,不传默认获取全部(只支持32位) |
ShowFlag | 否 | Integer | 是否仅展示当前目录下用户 1: 递归显示 2:仅显示当前目录下用户(只支持32位) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DescribeLocalAccountsPage | 获取账号列表响应的分页对象 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 normal
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLocalAccounts
<公共请求参数>
{
"Condition": {
"Filters": [
{
"Field": "abc",
"Operator": "abc",
"Values": [
"abc"
]
}
],
"FilterGroups": [
{
"Filters": [
{
"Field": "abc",
"Operator": "abc",
"Values": [
"abc"
]
}
]
}
],
"Sort": {
"Field": "abc",
"Order": "abc"
},
"PageSize": 0,
"PageNum": 0
},
"AccountGroupId": 0,
"ShowFlag": 0
}
输出示例
{
"Response": {
"Data": {
"Page": {
"PageSize": 1,
"PageNum": 1,
"PageCount": 1,
"Total": 1
},
"Items": [
{
"Id": 0,
"UserId": "abc",
"UserName": "abc",
"AccountId": 0,
"GroupId": 0,
"GroupName": "abc",
"NamePath": "abc",
"Source": 0,
"Status": 0,
"Itime": "abc",
"Utime": "abc",
"ExtraInfo": "abc",
"RiskLevel": "abc",
"AccountGroups": [
{
"AccountGroupId": 0
}
],
"MobileBindNum": 0,
"PcBindNum": 0,
"OnlineStatus": 0,
"ActiveStatus": 0,
"LoginTime": "abc",
"LogoutTime": "abc"
}
]
},
"RequestId": "abc"
}
}
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 | 请求参数错误。 |