查询消费者列表
更新时间:2026-08-17
接口描述
查询指定 AI 网关实例下的消费者列表。
OpenAPI Explorer
去调试
您可以在 OpenAPI Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1GET /v1/aigw/{instanceId}/consumers HTTP/1.1
2Host: aigw.bj.baidubce.com
3X-Region: bj
4Authorization: authorization string
请求头域
Plain Text
1必须传入 X-Region。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL参数 | AI 网关实例 ID |
| pageNo | Integer | 否 | Query参数 | 页码 |
| pageSize | Integer | 否 | Query参数 | 每页数量 |
| tagKey | String | 否 | Query参数 | 标签键 |
| tagValue | String | 否 | Query参数 | 标签值 |
返回状态码
成功返回 200;参数错误返回 400。
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否成功 |
| status | Integer | HTTP 状态码 |
| total | Integer | 消费者总数 |
| consumers | List |
消费者摘要列表 |
| nextToken | String | 下一页令牌 |
请求示例
Plain Text
1GET https://aigw.bj.baidubce.com/v1/aigw/aigw-example/consumers?pageSize=10 HTTP/1.1
2X-Region: bj
3Authorization: authorization string
返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3
4{"success":true,"status":200,"total":1,"consumers":[]}
评价此篇文章
