文档中心

API 网关

消费者管理

ListConsumers - 查询消费者列表

批量查询消费者配置信息。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=ListConsumers&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListConsumers

要执行的操作，取值：ListConsumers。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

PageNumber long 可选示例值：1

分页查询的页号。取值最小限制为 1，默认值为 1。

PageSize long 可选示例值：10

每页个数。取值范围为 0~100，默认值为 0。

Filter object 可选示例值：-

过滤条件。

Name string 可选示例值：example

消费者名称。

GatewayId string 可选示例值：gd8****

消费者所属网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total long 示例值：10

过滤后的总个数。

Items object[] 示例值：-

消费者列表。

Id string 示例值：consumer-crbc****

消费者 ID。

Name string 示例值：example

消费者名称。

GatewayId string 示例值：gd8****

消费者所属网关实例 ID。

GatewayName string 示例值：example

消费者所属网关实例名称。

CreateTime string 示例值：2025-01-01T00:00:00+08:00

消费者创建时间。标准 RFC3339 格式的 UTC+8 时间。

UpdateTime string 示例值：2025-01-01T00:00:00+08:00

消费者更新时间。标准 RFC3339 格式的 UTC+8 时间。

Comments string 示例值：example

消费者备注信息。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.10.28 14:59:50

这个页面对您有帮助吗？

有用

无用