1. 接口描述
接口请求域名： lke.tencentcloudapi.com 。
接口调用token详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTokenUsage。 |
| Version | 是 | String | 公共参数，本接口取值：2023-11-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| UinAccount.N | 否 | Array of String | 腾讯云主账号 |
| LoginUin | 否 | String | 登录用户主账号(集成商模式必填) 示例值：6000005624511 |
| LoginSubAccountUin | 否 | String | 登录用户子账号(集成商模式必填) 示例值：6000005624511 |
| SubBizType | 否 | String | 知识引擎子业务类型: FileParse(文档解析)、Embedding、Rewrite(多轮改写)、 Concurrency(并发)、KnowledgeSummary(知识总结) KnowledgeQA(知识问答)、KnowledgeCapacity(知识库容量)、SearchEngine(搜索引擎) |
| ModelName | 否 | String | 模型标识 |
| StartTime | 否 | String | 开始时间戳, 单位为秒(默认值0) |
| EndTime | 否 | String | 结束时间戳, 单位为秒(默认值0， 必须大于开始时间戳) |
| AppBizIds.N | 否 | Array of String | 应用id列表 |
| SubScenes.N | 否 | Array of String | 筛选子场景(文档解析场景使用) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalTokenUsage | Float | 总token消耗量 |
| InputTokenUsage | Float | 输入token消耗 |
| OutputTokenUsage | Float | 输出token消耗 |
| ApiCallStats | Integer | 接口调用次数 |
| SearchUsage | Float | 搜索服务调用次数 |
| PageUsage | Integer | 文档解析消耗页数 |
| SplitTokenUsage | Float | 拆分token消耗量 |
| RagSearchUsage | Float | Rag检索次数 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取调用统计
获取调用统计
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTokenUsage
<公共请求参数>
{
"UinAccount": [
"700001187441"
]
}输出示例
{
"Response": {
"ApiCallStats": 10,
"InputTokenUsage": 1120,
"OutputTokenUsage": 101,
"RequestId": "716109cc-ee93-423a-85f0-a21fb7afcc4f",
"SearchUsage": 10,
"TotalTokenUsage": 1221
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
