获取用户组列表信息

最近更新时间:2024-03-12 01:29:48

我的收藏

1. 接口描述

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

获取用户组列表信息(包含查询条件)。

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

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListUserGroups。
Version String 公共参数,本接口取值:2021-04-20。
Region String 公共参数,本接口不需要传递此参数。
SearchCondition UserGroupInfoSearchCriteria 查询条件,支持多搜索条件组合、多数据范围匹配的搜索。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式,具体查询方式为:双引号("")表示全匹配、以星号(* ) 结尾表示字段部分匹配。如果该字段为空,则默认查全量表。
Sort SortCondition 排序条件集合。可排序的属性支持:用户组名称(DisplayName)、用户组ID(UserGroupId)、上次更新时间(LastModifiedDate)。如果该字段为空,则默认按照用户组名称正向排序。
Offset Integer 分页偏移量。Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询。
Limit Integer 分页读取数量。Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询。

3. 输出参数

参数名称 类型 描述
UserGroupList Array of UserGroupInformation 返回的用户组列表。
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 返回的用户组信息总数。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

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

{}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "baf1b9a7-eefa-497f-99e4-2ba8918a2c67",
        "UserGroupList": [
            {
                "LastModifiedDate": "2021-07-07T15:59:19.944+0800",
                "UserGroupId": "e16f643e-51ac-4748-a1e8-ac43a4a90e58",
                "UserGroupName": "字符串"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.OperationError 操作失败。
InvalidParameter.SearchCriteriaIllegal 列表搜索条件不合法。
InvalidParameterValue.ParameterIllegal 参数不合法。