1. 接口描述
接口请求域名: ioa.tencentcloudapi.com 。
以分页的方式查询账户目录列表,私有化调用path为:/capi/Assets/DescribeAccountGroups
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAccountGroups。 |
Version | 是 | String | 公共参数,本接口取值:2022-06-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Deepin | 否 | Integer | 搜索范围,0-仅搜直接子组,1-深层搜索(只支持32位) |
Condition | 否 | Condition | 滤条件、分页参数 排序条件 |
ParentId | 否 | Integer | 父分组id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DescribeAccountGroupsPageResp | 账户分组详情响应数据 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询账号列表
输入示例
Path : /capi/Assets/DescribeAccountGroups
<body>
{
"Condition":{
"PageNum":0,
"PageSize":10,
"Sort":{
"Field":"Itime",
"Order":"desc"
}
},
"ParentId":1
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"Source": 0,
"IdPath": "1.30",
"ImportType": "zijian",
"Id": 30,
"UserTotal": 0,
"IsLeaf": false,
"ReadOnly": false,
"ParentId": 1,
"ExtraInfo": "",
"OrgId": "30",
"NamePath": "分组路径",
"Description": "",
"IdPathArr": [
1,
30
],
"Utime": "2022-07-21 10:24:11",
"Name": "用户名",
"Itime": "2022-07-21 10:24:11",
"ParentOrgId": "0",
"MiniIamId": ""
}
],
"Page": {
"PageSize": 10,
"PageNum": 0,
"Total": 4,
"PageCount": 1
}
},
"RequestId": "1658388211.551832"
}
}
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 | 内部错误,数据库异常。 |
InternalError.Unknown | 内部未知错误。 |
InvalidParameter.RequestParam | 请求参数错误。 |
MissingParameter.CommonParam | 缺少公共参数。 |
ResourceNotFound.NotFound | 资源不存在。 |
UnauthorizedOperation.PermissionDenied | 未授权的操作。 |