查询用量排行列表

1. 接口描述

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

查询用量排行列表。

指标族（MetricType）

• tokens（默认）：Token 用量统计。支持 Dimension = apikey / endpoint / model。
  返回指标：TotalToken（总）/ InputTotalToken（输入）/ OutputTotalToken（输出）/ CacheTotalToken（读缓存）。
• search：【待上线】联网搜索用量统计。支持 Dimension = apikey / endpoint / model。
  返回指标：SearchRequestCount（搜索请求数）/ SearchCount（搜索引擎调用次数）。

响应内容

• MetricType 字段用于切换指标族，响应回显 MetricType 与 MetricKeys。
• TotalStats：时间窗内全部对象的整段聚合值。
• PageStats：当前翻页内对象的整段聚合值。
• TopList：按MetricKeys[0]降序的对象列表，含整段聚合值与逐时间点曲线。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 DescribeUsageRankList

输入示例

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

{
    "Dimension": "apikey",
    "StartTime": "2026-04-09T00:00:00+08:00",
    "EndTime": "2026-05-09T00:00:00+08:00",
    "Period": 86400,
    "Target": "ak-20260618-**************************"
}

输出示例

{
    "Response": {
        "Dimension": "apikey",
        "EndTime": "2026-05-09T00:00:00+08:00",
        "Limit": 0,
        "MetricKeys": [
            "TotalToken",
            "InputTotalToken",
            "OutputTotalToken"
        ],
        "MetricType": "tokens",
        "Offset": 0,
        "PageStats": {
            "InputTotalToken": 0,
            "OutputTotalToken": 0,
            "TotalToken": 0
        },
        "Period": 86400,
        "RequestId": "1568bc1c-946b-4c2b-b69f-6ba93f2bb258",
        "StartTime": "2026-04-09T00:00:00+08:00",
        "Timestamps": [],
        "TopList": [],
        "Total": 0,
        "TotalStats": {
            "InputTotalToken": 0,
            "OutputTotalToken": 0,
            "TotalToken": 0
        },
        "ViewName": "tokenhub_uin_apikeyid"
    }
}

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. 错误码

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