You need to enable JavaScript to run this app.
文档中心
云原生消息引擎

云原生消息引擎

复制全文
下载 pdf
Group 管理
CreateGroup - 创建消费组
复制全文
下载 pdf
CreateGroup - 创建消费组
调用 CreateGroup 接口,创建 Consumer Group。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://open.volcengineapi.com?Action=CreateGroup&Version=2023-06-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:CreateGroup​
要执行的操作,取值:CreateGroup。​
​
Version string 必选 示例值:2023-06-01​
API的版本,取值:2023-06-01。​
​
GroupName string 必选 示例值:bmq-cg-1​
自定义设置Consumer Group 的名称,约束限制如下:​
  • 只能由小写英文字符、数字、下划线和中划线(-)组成。​
  • 长度为 3~64 字符。​
​
InstanceId string 必选 示例值:o-00c0****m46c​
Consumer Group 所属实例 ID。​
​
Description string 可选 示例值:测试使用​
Consumer Group 的描述语句。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
GroupId string 示例值:25950****901433daa48208d5450cd19​
Consumer Group 的 ID。​
​
​
​
请求示例​
​
POST /?Action=CreateGroup&Version=2023-06-01 HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241104T134340Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********​
​
{​
"GroupName": "bmq-cg-1",​
"InstanceId": "o-00c0****m46c"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202411042143441740051470288****",​
"Action": "CreateGroup",​
"Version": "2023-06-01",​
"Service": "bmq",​
"Region": "cn-beijing"​
},​
"Result": {​
"GroupId": "25950****901433daa48208d5450cd19"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
InvalidParameter​
parameter is invalid, pls check parameters​
参数值无效。​
200​
Unauthorized​
authorized error​
授权错误,请授权或切换账号后重试。​
200​
InternalServiceError​
internal service error, please contact with admin​
内部服务错误,请联系技术支持或提交工单。​
200​
DatabaseError​
database error​
数据库错误。​
200​
ParameterEncodingError​
Failure encoding object into query map​
参数编码异常,请联系技术支持或提交工单。​
​
​
最近更新时间:2025.08.05 18:34:37
这个页面对您有帮助吗?
有用
有用
无用
无用