查询消费者用量汇总
更新时间：2026-09-22
该接口用于分页查询指定消费者在给定时间范围内的用量明细，数据按日期和后端聚合，并支持按后端筛选。
查询时间范围包含起止时刻；响应中的 Token、请求次数和金额汇总基于全部匹配数据计算，不受分页影响。
请求结构
Plain Text
1POST /?action=DescribeConsumerUsageSummary HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "keyword": keyword,
7 "keywordType": keywordType,
8 "pageNo": pageNo,
9 "pageSize": pageSize,
10 "order": order,
11 "orderBy": orderBy,
12 "orders" : [order],
13 "filters" : [filter],
14 "consumerId": consumerId,
15 "startTime": startTime,
16 "endTime": endTime,
17 "backendId": backendId
18}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| keyword | String | 否 | RequestBody参数 | 关键字 |
| keywordType | String | 否 | RequestBody参数 | 关键字类型 |
| pageNo | int | 否 | RequestBody参数 | 页码 |
| pageSize | int | 否 | RequestBody参数 | 每页数据项数目 |
| order | String | 否 | RequestBody参数 | 排序方向 |
| orderBy | String | 否 | RequestBody参数 | 排序字段 |
| orders | List<OrderModel> | 否 | RequestBody参数 | 多重排序 |
| filters | List<FilterModel> | 否 | RequestBody参数 | 过滤字段 |
| consumerId | String | 是 | RequestBody参数 | 消费者 ID |
| startTime | String | 是 | RequestBody参数 | 查询起始时间 |
| endTime | String | 是 | RequestBody参数 | 查询结束时间 |
| backendId | String | 否 | RequestBody参数 | 后端 ID，可选，不传查询全部 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序方向 |
| pageNo | int | 页码 |
| pageSize | int | 每页数据项数目 |
| totalCount | long | 数据总条数 |
| result | List<ConsumerUsageSummaryItemResp> | 当前页的用量明细列表 |
| totalInputTokens | long | 时间段内输入Token总量（不受分页影响） |
| totalOutputTokens | long | 时间段内输出Token总量（不受分页影响） |
| totalCacheTokens | long | 时间段内缓存命中Token总量（不受分页影响） |
| totalRequestCount | long | 时间段内请求次数总计（不受分页影响） |
| totalInputCash | Double | 时间段内输入金额总计（不受分页影响） |
| totalOutputCash | Double | 时间段内输出金额总计（不受分页影响） |
| totalCacheCash | Double | 时间段内缓存金额总计（不受分页影响） |
| totalCash | Double | 时间段内总金额（不受分页影响） |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: consumerId must not be blank | 400 | 必填参数缺失或格式不合法，consumerId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源，请确认使用正确的账号凭证且资源属于当前账号 |
| ConsumerNotExist | Consumer not exist. | 404 | consumerId 对应的消费者不存在、不属于当前账号或已删除 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribeConsumerUsageSummary HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "consumerId": "consumer-a1b2c3d4",
7 "startTime": "2026-09-01 00:00:00",
8 "endTime": "2026-09-08 23:59:59",
9 "pageNo": 1,
10 "pageSize": 20
11}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "pageNo": 1,
9 "pageSize": 20,
10 "totalCount": 1,
11 "result": [
12 {
13 "date": "2026-09-08",
14 "backendId": "bd-a1b2c3d4",
15 "backendName": "对话后端",
16 "backendDeleted": false,
17 "totalInputTokens": 120000,
18 "totalOutputTokens": 80000,
19 "totalCacheTokens": 20000,
20 "totalRequestCount": 1500,
21 "totalInputCash": 2.4,
22 "totalOutputCash": 3.2,
23 "totalCacheCash": 0.1,
24 "totalCash": 5.7
25 }
26 ],
27 "totalInputTokens": 120000,
28 "totalOutputTokens": 80000,
29 "totalCacheTokens": 20000,
30 "totalRequestCount": 1500,
31 "totalInputCash": 2.4,
32 "totalOutputCash": 3.2,
33 "totalCacheCash": 0.1,
34 "totalCash": 5.7
35}评价此篇文章