查询TBDS用户组分页列表

最近更新时间: 2026-09-17 00:05:48

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.cn。

该接口用于查询TBDS用户组分页列表

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

接口更新时间：2025-09-12 15:26:10。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeUserGroupPage
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	是	否	Int64	偏移量，最小值为0，该值除以Limit参数向上取整表示当前页数示例值： 0
Limit	是	否	Int64	每页返回数量，最小值为1，表示返回1条数据示例值： 10
Filters	否	否	Array of Api3Filter	筛选条件，Name取值范围：Keyword(用户组名模糊查询， Values填写部分或完整的用户组名称，仅取数组第一个值) 示例值：查看
OrderFields	否	否	Array of Api3Order	排序条件，Name取值范围：CreateTime(按照创建时间排序)，UpdateTime(按照更新时间排序)。Direction取值范围: ASC 正序，DESC 倒序示例值：查看

3. 输出参数

参数名称	类型	描述
Data	UserGroupPageResponse	用户组分页列表注意：此字段可能返回 null，表示取不到有效值。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
FailedOperation	操作失败。

5. 示例

示例1 获取用户组分页列表

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeUserGroupPage
<公共请求参数>

{
  "Offset": 0,
  "Limit": 10,
  "Filters": [
    {
      "Name": "Name",
      "Values": [
        "testgroup"
      ]
    }
  ]
}

输出示例

{
    "Response": {
        "RequestId": "req-123456818",
        "Data": {
            "List": [
                {
                    "Id": 4001,
                    "Name": "testgroup",
                    "Remark": "测试用户组",
                    "CreateTime": "2023-12-01 10:00:00",
                    "UpdateTime": "2023-12-01 10:00:00",
                    "LdapGroupName": "testgroup_ldap"
                }
            ],
            "TotalCount": 1
        }
    }
}