iOA 零信任安全管理系统查询账号分组列表-账号管理相关接口-API 中心-腾讯云

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-当前分组的所有子组。默认为0。示例值：0
Condition	否	Condition	查询条件过滤参数 1、Name，string类型，按分组名过滤是否必填：否操作符: like 排序条件 1、Itime，string类型，按分组创建时间排序是否必填：否 2、Utime，string类型，按分组更新时间排序是否必填：否示例值：{ "Filters": [ { "Field": "Name", "Operator": "like", "Values": [ "研发" ] } ] }
ParentId	否	Integer	父分组ID，获取该分组下的子组信息。默认查询全网根分组下子组信息。示例值：82119

3. 输出参数

参数名称	类型	描述
Data	DescribeAccountGroupsPageResp	账号分组详情响应数据示例值：无，参考接口示例部分
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询账号分组列表

输入示例

POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccountGroups
<公共请求参数>

{
    "Deepin": 1,
    "Condition": {
        "Filters": [
            {
                "Field": "Name",
                "Operator": "like",
                "Values": [
                    "研发"
                ]
            }
        ]
    },
    "ParentId": 82119
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "Description": "这是一个研发部门",
                    "ExtraInfo": "{\"salt\": \"5b52ea107e85a7b46d2c1b15a5faf722\"}",
                    "Id": 510945,
                    "IdPath": "14632.82119.510943.510945",
                    "IdPathArr": [
                        14632,
                        82119,
                        510943,
                        510945
                    ],
                    "ImportType": "zijian",
                    "IsLeaf": false,
                    "Itime": "2024-10-21 14:34:01",
                    "LatestSyncResult": "Success",
                    "LatestSyncTime": "2024-10-20 09:00:01",
                    "MiniIamId": "13178683927JH5h7jtvXdCqPLKnC46gC",
                    "Name": "研发部",
                    "NamePath": "全网账户.pf自建.集团.研发部",
                    "OrgId": "510945",
                    "ParentId": 510943,
                    "ParentOrgId": "510943",
                    "ReadOnly": false,
                    "Source": 0,
                    "UserTotal": 1,
                    "Utime": "2024-10-21 14:34:16"
                },
                {
                    "Description": "这是一个研发组",
                    "ExtraInfo": "{\"salt\": \"5b52ea107e85a7b46d2c1b15a5faf722\"}",
                    "Id": 510947,
                    "IdPath": "14632.82119.510943.510945.510947",
                    "IdPathArr": [
                        14632,
                        82119,
                        510943,
                        510945,
                        510947
                    ],
                    "ImportType": "zijian",
                    "IsLeaf": true,
                    "Itime": "2024-10-21 14:34:37",
                    "LatestSyncResult": "Success",
                    "LatestSyncTime": "2024-10-20 09:00:01",
                    "MiniIamId": "13178683927JH5h7jtvXdCqPLKnC46gC",
                    "Name": "研发一组",
                    "NamePath": "全网账户.pf自建.集团.研发部.研发一组",
                    "OrgId": "510947",
                    "ParentId": 510945,
                    "ParentOrgId": "510945",
                    "ReadOnly": false,
                    "Source": 0,
                    "UserTotal": 0,
                    "Utime": "2024-10-21 14:34:37"
                },
                {
                    "Description": "这是另一个研发组",
                    "ExtraInfo": "{\"salt\": \"5b52ea107e85a7b46d2c1b15a5faf722\"}",
                    "Id": 510948,
                    "IdPath": "14632.82119.510943.510945.510948",
                    "IdPathArr": [
                        14632,
                        82119,
                        510943,
                        510945,
                        510948
                    ],
                    "ImportType": "zijian",
                    "IsLeaf": true,
                    "Itime": "2024-10-21 14:34:52",
                    "LatestSyncResult": "Success",
                    "LatestSyncTime": "2024-10-20 09:00:01",
                    "MiniIamId": "13178683927JH5h7jtvXdCqPLKnC46gC",
                    "Name": "研发二组",
                    "NamePath": "全网账户.pf自建.集团.研发部.研发二组",
                    "OrgId": "510948",
                    "ParentId": 510945,
                    "ParentOrgId": "510945",
                    "ReadOnly": false,
                    "Source": 0,
                    "UserTotal": 1,
                    "Utime": "2024-10-21 14:34:52"
                }
            ],
            "Page": {
                "PageCount": 1,
                "PageNum": 0,
                "PageSize": 10,
                "Total": 3
            }
        },
        "RequestId": "365d01ca-41d2-45b8-97d5-b8e5ce2c5148"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.DatabaseException	内部错误，数据库异常。
InternalError.Unknown	内部未知错误。
InvalidParameter.RequestParam	请求参数错误。
MissingParameter.CommonParam	缺少公共参数。
ResourceNotFound.NotFound	资源不存在。
UnauthorizedOperation.PermissionDenied	未授权的操作。