文档中心

API 网关

消费者管理

CreateConsumer - 创建消费者

创建消费者。

请求说明

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

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

调试

API Explorer

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

请求参数

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

Action string 必选示例值：CreateConsumer

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

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

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

Name string 必选示例值：example

消费者名称。

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

网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。

Comments string 可选示例值：example

消费者备注信息。长度限制为 0~253 个字符。

Tags object[] 可选示例值：-

标签。长度限制为 0~1 个。

Key string 必选示例值：example-key

标签键。长度限制为 1~256 个字符。

Value string 可选示例值：example-value

标签值。长度限制为 0~256 个字符。

返回参数

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

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

消费者 ID。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
400	QuotaExceeded	%s has exceeded the quota.	指定资源的配额达到上限。请提升相关资源配额或删除无用资源，预留出配额后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。

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

这个页面对您有帮助吗？

有用

无用