You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
消费者管理
CreateConsumer - 创建消费者
复制全文
下载 pdf
CreateConsumer - 创建消费者
创建消费者。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=CreateConsumer&Version=2021-03-03​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
CreateConsumer​
接口名称。当前 API 的名称为 CreateConsumer。​
Version​
String​
是​
2021-03-03​
接口版本。当前 API 的版本为 2021-03-03。​
Name​
String​
是​
example​
消费者名称。​
  • 支持大小写字母、数字和中划线(-),长度限制为 2~63 个字符。​
  • 不能以中划线(-)开头。​
GatewayId​
String​
是​
gd8****​
网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。​
Comments​
String​
否​
example​
消费者备注信息。长度限制为 0~253 个字符。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=CreateConsumer&Version=2021-03-03​
Content-Type: application/json​
{​
"Name": "example",​
"GatewayId": "gd8****",​
"Comments": "example"​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Id​
String​
consumer-crbc****​
消费者 ID。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "CreateConsumer",​
"Version": "2021-03-03",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"Id": "consumer-crbc****"​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:04
这个页面对您有帮助吗?
有用
有用
无用
无用