查询消费者详情
更新时间：2026-04-24
接口描述
本接口用于查询指定 AI 网关实例下某个消费者的详细信息，包含凭证、配额、重置周期及关联路由等。支持按消费者 ID 或消费者名称查询。
注意事项
- 路径参数
consumerID可传消费者 ID 或消费者名称；通过查询参数keyType切换：id（默认）、name。 totalQuota/quotaValue在不限 Token 配额时为-1；totalRequestQuota/requestQuotaValue在不限请求次数配额时为-1。quotaNextResetTime/requestQuotaNextResetTime为下次重置的 Unix 时间戳（秒），值为0表示不重置。pendingQuotaReset*/pendingRequestQuotaReset*：next_reset模式更新重置周期后出现，到达下次重置时自动覆盖当前quotaReset*/requestQuotaReset*并清空；pendingQuotaResetType为空字符串或字段缺省时表示无待生效重置规则。
请求结构
Plain Text
1GET /v1/aigw/{instanceId}/consumer/{consumerID}?keyType={keyType} 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 |
| consumerID | String | 是 | URL参数 | 消费者 ID 或消费者名称，由 keyType 决定含义 |
| keyType | String | 否 | Query参数 | 路径参数类型，可选值：id（按消费者 ID，默认）、name（按消费者名称） |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| consumerId | String | 消费者 ID |
| consumerName | String | 消费者名称 |
| description | String | 消费者描述，若无则为空字符串 |
| authType | String | 认证方式，如 KeyAuth |
| authVersion | Integer | 认证版本号，2 表示 2.0 |
| credentials | List<Credential> | 凭证列表 |
| credentialLocation | CredentialLocation | 消费者级凭证位置默认配置 |
| credentialPlaceholder | Boolean | 是否为空凭证占位 |
| credentialLocationConfigured | Boolean | 用户是否显式配置过凭证位置 |
| unlimitedQuota | Boolean | 是否不限 Token 配额 |
| totalQuota | Integer | Token 配额初始总量，不限额时为 -1 |
| quotaValue | Integer | Token 配额剩余值（实时），不限额时为 -1 |
| usedQuota | Integer | 当前周期已使用 Token 数 |
| pendingTotalQuota | Integer | 下个周期将生效的 Token 配额上限；quotaEffectMode=next_reset 更新后出现，到达 quotaNextResetTime 后自动替换 totalQuota 并被清零；无待生效时字段不返回或为 0 |
| quotaResetType | String | Token 配额重置周期：none/daily/weekly/monthly |
| quotaResetDay | Integer | 每月重置日（1-31） |
| quotaResetWeekday | Integer | 每周重置星期（0=周日，…，6=周六） |
| quotaResetHour | Integer | 重置时刻小时（0-23，CST） |
| quotaResetMinute | Integer | 重置时刻分钟（0-59） |
| quotaNextResetTime | Integer | 下次 Token 配额重置时间（Unix 时间戳秒），0 表示不重置 |
| pendingQuotaResetType | String | 下个周期将生效的重置周期；quotaEffectMode=next_reset 更新重置规则后出现，到达 quotaNextResetTime 时自动替换 quotaResetType 等字段并被清空；空字符串或字段缺省表示无待生效 |
| pendingQuotaResetDay | Integer | 待生效的每月重置日（1-31），语义同 pendingQuotaResetType |
| pendingQuotaResetWeekday | Integer | 待生效的每周重置星期（0=周日，…，6=周六），语义同 pendingQuotaResetType |
| pendingQuotaResetHour | Integer | 待生效的重置时刻小时（0-23，CST），语义同 pendingQuotaResetType |
| pendingQuotaResetMinute | Integer | 待生效的重置时刻分钟（0-59），语义同 pendingQuotaResetType |
| unlimitedRequestQuota | Boolean | 是否不限请求次数配额 |
| totalRequestQuota | Integer | 请求次数配额初始总量，不限额时为 -1 |
| requestQuotaValue | Integer | 请求次数配额剩余值（实时），不限额时为 -1 |
| usedRequestQuota | Integer | 当前周期已使用请求次数 |
| pendingTotalRequestQuota | Integer | 下个周期将生效的请求次数配额上限，语义同 pendingTotalQuota |
| requestQuotaResetType | String | 请求次数配额重置周期：none/daily/weekly/monthly |
| requestQuotaResetDay | Integer | 每月重置日（1-31） |
| requestQuotaResetWeekday | Integer | 每周重置星期（0=周日，…，6=周六） |
| requestQuotaResetHour | Integer | 重置时刻小时（0-23，CST） |
| requestQuotaResetMinute | Integer | 重置时刻分钟（0-59） |
| requestQuotaNextResetTime | Integer | 下次请求次数配额重置时间（Unix 时间戳秒），0 表示不重置 |
| pendingRequestQuotaResetType | String | 下个周期将生效的请求次数重置周期，语义同 pendingQuotaResetType |
| pendingRequestQuotaResetDay | Integer | 待生效的每月重置日（1-31） |
| pendingRequestQuotaResetWeekday | Integer | 待生效的每周重置星期（0=周日，…，6=周六） |
| pendingRequestQuotaResetHour | Integer | 待生效的重置时刻小时（0-23，CST） |
| pendingRequestQuotaResetMinute | Integer | 待生效的重置时刻分钟（0-59） |
| srcProduct | String | 来源产品标识 |
| routes | List<Route> | 关联路由列表 |
| tags | List<Tag> | 标签列表 |
Credential 字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| identityId | Long | 凭证在身份服务中的 ID |
| name | String | 凭证名称 |
| description | String | 凭证描述 |
| value | String | 凭证明文 |
| maskedValue | String | 脱敏后的凭证值 |
| generateMode | String | 生成方式：auto（自动）/custom（自定义） |
| inHeader | Boolean | 是否通过 Header 传递 |
| inQuery | Boolean | 是否通过 Query 传递 |
| keyNames | List<String> | Header/Query 的 key 名列表 |
| status | String | 凭证状态：active/revoked |
| createdAt | String | 创建时间，RFC3339 |
| updatedAt | String | 更新时间，RFC3339 |
| lastUsedAt | String | 最近一次使用时间，RFC3339 |
| usedCount | Long | 累计使用次数 |
CredentialLocation 字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| inHeader | Boolean | 是否通过 Header 传递 |
| inQuery | Boolean | 是否通过 Query 传递 |
| keyNames | List<String> | Header/Query 的 key 名列表 |
Route 字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| routeName | String | 路由名称 |
| createTime | String | 路由创建时间，格式：YYYY-MM-DD HH:mm:ss |
| authEnabled | Boolean | 路由是否开启消费者认证 |
Tag 字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |
请求示例
Plain Text
1按消费者 ID 查询（默认）
2GET http://aigw.bj.baidubce.com/v1/aigw/i-a1b2c3d4/consumer/cs-002
3Host: aigw.bj.baidubce.com
4X-Region: bj
5Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2026-04-23T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Plain Text
1按消费者名称查询
2GET http://aigw.bj.baidubce.com/v1/aigw/i-a1b2c3d4/consumer/limited-consumer?keyType=name
3Host: aigw.bj.baidubce.com
4X-Region: bj
5Authorization: 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 "consumerId": "cs-002",
7 "consumerName": "limited-consumer",
8 "description": "限额消费者",
9 "authType": "KeyAuth",
10 "authVersion": 2,
11 "credentials": [
12 {
13 "identityId": 18,
14 "name": "c2-auto-key",
15 "description": "auto token",
16 "value": "Bearer 9d9b2f86-ec8bde77-444b-57ce9ce6e6b6",
17 "maskedValue": "Bea******6b6",
18 "generateMode": "auto",
19 "inHeader": true,
20 "inQuery": false,
21 "keyNames": ["Authorization"],
22 "status": "active",
23 "createdAt": "2026-04-20T16:25:06+08:00",
24 "updatedAt": "2026-04-20T16:25:06+08:00",
25 "lastUsedAt": "2026-04-22T10:12:30+08:00",
26 "usedCount": 3
27 }
28 ],
29 "unlimitedQuota": false,
30 "totalQuota": 5000,
31 "quotaValue": 2500,
32 "usedQuota": 2500,
33 "quotaResetType": "daily",
34 "quotaResetDay": 0,
35 "quotaResetWeekday": 0,
36 "quotaResetHour": 0,
37 "quotaResetMinute": 0,
38 "quotaNextResetTime": 1745510400,
39 "unlimitedRequestQuota": false,
40 "totalRequestQuota": 100,
41 "requestQuotaValue": 80,
42 "usedRequestQuota": 20,
43 "requestQuotaResetType": "weekly",
44 "requestQuotaResetDay": 0,
45 "requestQuotaResetWeekday": 1,
46 "requestQuotaResetHour": 0,
47 "requestQuotaResetMinute": 0,
48 "requestQuotaNextResetTime": 1745942400,
49 "routes": [
50 {"routeName": "route-001", "createTime": "2026-04-10 09:15:30", "authEnabled": true}
51 ],
52 "tags": [
53 {"tagKey": "env", "tagValue": "prod"}
54 ]
55}评价此篇文章