查询消费者列表
更新时间：2026-04-24
接口描述
本接口用于分页查询指定 AI 网关实例下的消费者列表，支持按创建时间排序。
注意事项
totalQuota/quotaValue：unlimitedQuota=true时返回-1，表示不限额。totalRequestQuota/requestQuotaValue：unlimitedRequestQuota=true时返回0，表示不限额。- 若消费者未填写
description，返回值为"-"。
请求结构
Plain Text
1GET /v1/aigw/{instanceId}/consumers?pageNo={pageNo}&pageSize={pageSize}&orderBy={orderBy}&order={order} HTTP/1.1
2Host: aigw.bj.baidubce.com
3X-Region: bj
4Authorization: authorization string请求头域
除公共头域外，还需传入以下头域：
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| X-Region | String | 是 | 地域代码，如 bj、gz、su 等 |
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL参数 | AI 网关实例 ID |
| pageNo | Integer | 否 | Query参数 | 页码，从 1 开始，默认 1 |
| pageSize | Integer | 否 | Query参数 | 每页条数，默认 10 |
| orderBy | String | 否 | Query参数 | 排序字段，默认 createTime |
| order | String | 否 | Query参数 | 排序方式，可选值：asc（升序）、desc（降序），默认 desc |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| page.orderBy | String | 排序字段 |
| page.order | String | 排序方式 |
| page.pageNo | Integer | 当前页码 |
| page.pageSize | Integer | 每页条数 |
| page.totalCount | Integer | 总记录条数 |
| page.result | List<Consumer> | 消费者列表 |
Consumer 字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| consumerId | String | 消费者 ID |
| consumerName | String | 消费者名称 |
| description | String | 消费者描述，若为空则返回 "-" |
| createTime | String | 创建时间，格式：YYYY-MM-DD HH:mm:ss |
| authVersion | Integer | 认证版本：1 表示 1.0，2 表示 2.0 |
| unlimitedQuota | Boolean | 是否不限 Token 配额 |
| totalQuota | Integer | Token 配额初始总量，不限额时为 -1 |
| quotaValue | Integer | Token 配额剩余值（实时），不限额时为 -1 |
| unlimitedRequestQuota | Boolean | 是否不限请求次数配额 |
| totalRequestQuota | Integer | 请求次数配额初始总量，不限额时为 0 |
| requestQuotaValue | Integer | 请求次数配额剩余值（实时），不限额时为 0 |
| tags | List<Tag> | 标签列表 |
Tag 字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |
请求示例
Plain Text
1GET http://aigw.bj.baidubce.com/v1/aigw/i-a1b2c3d4/consumers?pageNo=1&pageSize=10&orderBy=createTime&order=desc
2Host: aigw.bj.baidubce.com
3X-Region: bj
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2026-04-23T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
4
5{
6 "page": {
7 "orderBy": "createTime",
8 "order": "desc",
9 "pageNo": 1,
10 "pageSize": 10,
11 "totalCount": 2,
12 "result": [
13 {
14 "consumerId": "cs-001",
15 "consumerName": "unlimited-consumer",
16 "description": "不限额消费者",
17 "createTime": "2026-04-10 09:15:30",
18 "authVersion": 2,
19 "unlimitedQuota": true,
20 "totalQuota": -1,
21 "quotaValue": -1,
22 "unlimitedRequestQuota": true,
23 "totalRequestQuota": 0,
24 "requestQuotaValue": 0,
25 "tags": []
26 },
27 {
28 "consumerId": "cs-002",
29 "consumerName": "limited-consumer",
30 "description": "-",
31 "createTime": "2026-04-12 14:30:25",
32 "authVersion": 2,
33 "unlimitedQuota": false,
34 "totalQuota": 5000,
35 "quotaValue": 2500,
36 "unlimitedRequestQuota": false,
37 "totalRequestQuota": 100,
38 "requestQuotaValue": 80,
39 "tags": [
40 {"tagKey": "env", "tagValue": "prod"}
41 ]
42 }
43 ]
44 }
45}评价此篇文章