数字身份管控平台（员工版）
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数字身份管控平台（员工版） > API 文档 > 控制台相关接口 > 查询账号组列表

查询账号组列表

最近更新时间：2022-02-24 08:07:56

我的收藏

本页目录：

1. 接口描述

接口请求域名： eiam.tencentcloudapi.com 。

查询账号组列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
本文档展示的是V1签名的参数说明，腾讯云建议您使用安全系数更高的V3签名算法，使用签名方法 v3 时，公共参数需要统一放到 HTTP Header 请求头部中，详情。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeAccountGroup。
Version 是 String 公共参数，本接口取值：2021-04-20。
Region 否 String 公共参数，本接口不需要传递此参数。
ApplicationId 是 String 应用ID。
SearchCondition 否 AccountGroupSearchCriteria 查询条件，支持多搜索条件组合、多数据范围匹配的搜索。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式，具体查询方式为：双引号（“”）表示全匹配、以星号（*）结尾表示字段部分匹配。如果该字段为空，则默认查全量表。
Offset 否 Integer 偏移量，默认为 0。
Limit 否 Integer 返回数量，默认为 20，最大值为 100。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 返回查询的总记录数。
注意：此字段可能返回 null，表示取不到有效值。
ApplicationId String 应用ID。
注意：此字段可能返回 null，表示取不到有效值。
AccountGroupList Array of AccountGroupInfo 返回符合条件的数据列表。
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

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

{
    "SearchCondition": {
        "Keyword": "xx"
    },
    "Limit": 0,
    "Offset": 0,
    "ApplicationId": "xx"
}

输出示例

{
  "Response": {
    "TotalCount": 1,
    "AccountGroupList": {
      "AccountGroupId": "xx",
      "GroupName": "xx",
      "Description": "xx",
      "CreatedDate": "xx"
    },
    "ApplicationId": "xx",
    "RequestId": "xx"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AppNotExist 应用不存在。
FailedOperation.OperationError 操作失败。
InvalidParameterValue.ParameterIllegal 参数不合法。
中国站