1. 接口描述
接口请求域名: tokenhub.tencentcloudapi.com 。
查询 TokenPlan APIKey 调用明细。
从 CLS 日志服务查询套餐下的调用明细,按 pkg_id 过滤,支持游标分页。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTokenPlanApiKeyUsageDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2026-03-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TeamId | 是 | String | 套餐 ID。可通过DescribeTokenPlanList接口获取。 示例值:tp-ent-abcdefgh |
| From | 否 | String | 起始时间,RFC3339 格式。不传默认为结束时间前 15 分钟。 示例值:2026-04-06T00:00:00Z |
| To | 否 | String | 结束时间,RFC3339 格式。不传默认为当前时间。 示例值:2026-04-06T12:00:00Z |
| Sort | 否 | String | 排序方式。取值:asc(升序)、desc(降序),默认为 desc。 示例值:desc |
| Limit | 否 | Integer | 返回条数,默认为 20,最大值为 100。 示例值:20 |
| Context | 否 | String | 翻页上下文,首次查询不传,后续传入上次返回的 Context,直到 ListOver 为 true。 示例值:Context |
| ApiKeyId | 否 | String | 按 API Key ID 精确过滤。最大 128 字符。与 ApiKeyName 至少需传入其一,都传时以 ApiKeyId 为准。可通过 DescribeTokenPlanApiKeyList 接口获取。 示例值:ak-tp-20260511-e72cbd58f07906010f862a5acd597010 |
| ApiKeyName | 否 | String | 按 API Key 名称模糊过滤。最大 64 字符。与 ApiKeyId 至少需传入其一,都传时以 ApiKeyId 为准。 示例值:apikey-test |
| ModelName | 否 | String | 按模型 ID (Model ID) 精确过滤。需要按模型名称过滤时传入该字段。 示例值:auto |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Context | String | 翻页上下文,传入下一次请求的 Context 参数继续翻页。 示例值:Context |
| ListOver | Boolean | 是否已到末尾,为 true 时无需继续翻页。 示例值:true |
| List | Array of UsageDetailItem | 调用明细列表。 |
| ProductType | String | 套餐类型。取值:enterprise(企业版专业套餐)、enterprise-auto(企业版轻享套餐) 示例值:enterprise |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeTokenPlanApiKeyUsageDetail
输入示例
POST / HTTP/1.1
Host: tokenhub.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTokenPlanApiKeyUsageDetail
<公共请求参数>
{
"TeamId": "team-123456"
}
输出示例
{
"Response": {
"Context": "",
"List": [
{
"CacheToken": 0,
"OutputToken": 39,
"ApiKeyId": "ak-tp-20260408-123456",
"RequestTime": "2026-04-10T14:24:45Z",
"ModelName": "auto",
"Uin": "123456",
"RequestId": "451d5d39-9ed9-46f8-8dce-df582c3b2d0e",
"InputToken": 66,
"TotalToken": 105
}
],
"ListOver": true,
"RequestId": "409be278-ce7c-4362-93a5-62391cdf4256"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InternalError | InternalError.InternalError |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| MissingParameter.MissingParameter | MissingParameter.MissingParameter |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |