1. 接口描述
接口请求域名: cngw.tencentcloudapi.com 。
查询 AI 网关Token 消耗统计
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCloudNativeAPIGatewayLLMTokenUsageList。 |
| Version | 是 | String | 公共参数,本接口取值:2023-04-18。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| GatewayId | 是 | String | 网关实例Id 示例值:gateway-0663f44f |
| StartTime | 是 | Integer | 查询起始时间戳 单位:秒 示例值:1779638400 |
| EndTime | 是 | Integer | 查询结束时间戳 单位:秒 示例值:1779690592 |
| Filters.N | 否 | Array of Filter | 查询过滤条件,Name取值为ConsumerId或ConsumerGroupId |
| Limit | 否 | Integer | 分页条件,每页条数 示例值:20 |
| Offset | 否 | Integer | 分页条件,分页偏移量 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | AIGWLLMTokenUsageListResult | 查询Token用量明细结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据消费者筛选
输入示例
POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudNativeAPIGatewayLLMTokenUsageList
<公共请求参数>
{
"GatewayId": "gateway-0663f44f",
"StartTime": 1779638400,
"EndTime": 1779690592,
"Filters": [
{
"Name": "ConsumerId",
"Values": [
"2e36f421-e08f-4e9e-a610-1b1f84c9cb6d"
]
}
],
"Limit": 20,
"Offset": 0
}
输出示例
{
"Response": {
"Result": {
"DataList": [
{
"CacheReadInputTokens": 0,
"ConsumerGroups": [
{
"ConsumerGroupId": "cg-3155bd3c9fd0df",
"Name": "test-consumer-group-1"
}
],
"ConsumerId": "2e36f421-e08f-4e9e-a610-1b1f84c9cb6d",
"ConsumerName": "test-consumer-2",
"Cost": "0.00",
"Currency": "CNY",
"InputTokens": 45,
"ModelServiceId": "b97facfd14724ccea64358fd1769b784",
"ModelServiceName": "qwen",
"OutputTokens": 11,
"RequestCount": 2,
"TotalTokens": 56
}
],
"TotalCount": 1
},
"RequestId": "79a1003e-8d6f-4b14-a61e-b04c4f9e004b"
}
}
示例2 根据消费者组筛选
输入示例
POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudNativeAPIGatewayLLMTokenUsageList
<公共请求参数>
{
"GatewayId": "gateway-0663f44f",
"StartTime": 1779638400,
"EndTime": 1779690592,
"Filters": [
{
"Name": "ConsumerGroupId",
"Values": [
"cg-6e111dd2fc5cee"
]
}
],
"Limit": 20,
"Offset": 0
}
输出示例
{
"Response": {
"Result": {
"DataList": [
{
"CacheReadInputTokens": 0,
"ConsumerGroups": [
{
"ConsumerGroupId": "cg-6e111dd2fc5cee",
"Name": "test-consumer-group-2"
}
],
"ConsumerId": "2e36f421-e08f-4e9e-a610-1b1f84c9cb6d",
"ConsumerName": "test-consumer-2",
"Cost": "0.00",
"Currency": "CNY",
"InputTokens": 45,
"ModelServiceId": "b97facfd14724ccea64358fd1769b784",
"ModelServiceName": "qwen",
"OutputTokens": 11,
"RequestCount": 2,
"TotalTokens": 56
}
],
"TotalCount": 1
},
"RequestId": "dff1a641-28ea-4c7f-91cc-c89467dc70ef"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
| FailedOperation.InternalError | FailedOperation.InternalError |
| LimitExceeded.LimitExceeded | LimitExceeded.LimitExceeded |
| MissingParameter.MissParameter | MissingParameter.MissParameter |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.InstanceNotFound | ResourceNotFound.InstanceNotFound |
| ResourceNotFound.ResourceNotFound | ResourceNotFound.ResourceNotFound |
| UnauthorizedOperation.Uin | UnauthorizedOperation.Uin |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |