API 网关
API 网关
文档指南
请输入
- 文档首页
API 网关API 参考消费者管理ListConsumers - 批量查询消费者
复制全文
下载 pdfListConsumers - 批量查询消费者
文档反馈
问问助手批量查询消费者配置信息。
请求说明
- 请求方式：POST
- 请求地址：https://apig.cn-beijing.volcengineapi.com?Action=ListConsumers&Version=2021-03-03
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | ListConsumers | 接口名称。当前 API 的名称为 ListConsumers。 |
Version | String | 是 | 2021-03-03 | 接口版本。当前 API 的版本为 2021-03-03。 |
PageNumber | Long | 否 | 1 | 分页查询的页号。取值最小限制为 1，默认值为 1。 |
PageSize | Long | 否 | 10 | 每页个数。取值范围为 0~100，默认值为 0。 |
Filter | 否 | - | 过滤条件。 |
ConsumerFilter
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Name | String | 否 | example | 消费者名称。 |
GatewayId | String | 否 | gd8**** |
请求示例
返回参数
参数 | 类型 | 示例值 | 描述 |
Total | Long | 10 | 过滤后的总个数。 |
Items | - | 消费者列表。 |
ConsumerResponse
参数 | 类型 | 示例值 | 描述 |
Id | String | consumer-crbc**** | 消费者 ID。 |
Name | String | example | 消费者名称。 |
GatewayId | String | gd8**** | 消费者所属网关实例 ID。 |
GatewayName | String | example | 消费者所属网关实例名称。 |
CreateTime | String | 2025-01-01T00:00:00+08:00 | 消费者创建时间。 |
UpdateTime | String | 2025-01-01T00:00:00+08:00 | 消费者更新时间。 |
Comments | String | example | 消费者备注信息。 |
返回示例
错误码
最近更新时间：2026.07.29 10:20:05
这个页面对您有帮助吗？
有用
有用
无用
无用