负载均衡查询用户组列表

1. 接口描述

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

查询指定模型路由实例下的用户组列表或详情，支持按ID、名称、状态、标签过滤及分页。真实用户组按名称字典序升序返回；返回列表末尾恒追加一个「未分组」虚拟分组（UserGroupId 固定为 ugrp-ungrouped、UserGroupName 固定为 ungrouped），它并非用户真实创建的用户组，而是代表该实例下所有未归属任何用户组的 Key（其 KeyCount 为无组 Key 数，不计入 TotalCount，不可修改或删除）。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUserGroups。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。
ModelRouterId	是	String	模型路由实例ID。示例值：cmr-pm53f9c3
UserGroupIds.N	否	Array of String	用户组ID列表，用于按ID过滤，单次最多100个；可包含「未分组」虚拟分组 ugrp-ungrouped。示例值：["ugrp-9f8e7d6c"]
Filters.N	否	Array of Filter	过滤列表。支持：UserGroupName、Status、tag-key、tag:<tag-key>。
Limit	否	Integer	本次查询限制的数量取值范围：[1, 100] 默认值：20 示例值：20
Offset	否	Integer	本次查询偏移量默认值：0 示例值：0

3. 输出参数

参数名称	类型	描述
UserGroups	Array of UserGroupInfo	用户组列表。
TotalCount	Integer	符合条件的总数（含「未分组」逻辑组 ugrp-ungrouped：当其未被过滤条件排除时计入，即 TotalCount = 真实用户组数 + 1）。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询用户组列表

输入示例

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

{
    "ModelRouterId": "cmr-pm53f9c3",
    "Limit": 20,
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "UserGroups": [
            {
                "UserGroupId": "ugrp-9f8e7d6c",
                "UserGroupName": "核心业务组",
                "Status": "Active",
                "ModelRouterId": "cmr-pm53f9c3",
                "Models": [
                    "deepseek-v3"
                ],
                "IntentRouters": [
                    "ir-chat"
                ],
                "BudgetId": "budget-x1y2z3",
                "BudgetName": "核心组月度预算",
                "CreditUsageSet": [
                    {
                        "BudgetDuration": "30d",
                        "Limit": 1000.0,
                        "Used": 128.45,
                        "BudgetResetAt": "2026-07-01T00:00:00+08:00"
                    }
                ],
                "KeyCount": 12,
                "Tags": [
                    {
                        "TagKey": "dept",
                        "TagValue": "payments"
                    }
                ],
                "CreatedTime": "2026-06-16T10:00:00Z",
                "ModifiedTime": "2026-06-16T10:00:00Z"
            },
            {
                "UserGroupId": "ugrp-ungrouped",
                "UserGroupName": "ungrouped",
                "Status": "Active",
                "ModelRouterId": "cmr-pm53f9c3",
                "Models": [],
                "IntentRouters": [],
                "BudgetId": "",
                "BudgetName": "",
                "CreditUsageSet": [],
                "KeyCount": 7,
                "Tags": []
            }
        ],
        "RequestId": "d81e7b1f-3587-491b-8556-9e47222fecfd"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询用户组列表

本页目录：