文档中心

消息队列 RocketMQ版

Group管理

CreateGroupAsync - 异步创建 Group

调用 CreateGroupAsync 接口异步创建 Group。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：CreateGroupAsync

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

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

ConsumeMessageOrderly boolean 可选示例值：false

是否顺序消费。

RetryMaxTimes integer 可选示例值：16

消费失败重试次数。

InstanceId string 必选示例值：rocketmq-cnng232423****

实例 ID。

GroupId string 必选示例值：my_group

Group 的 ID。

GroupType string 必选示例值：TCP

指定创建的 Group 适用的协议，取值为TCP。

Description string 可选示例值：group-test

Group 的简单描述。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=CreateGroupAsync&Version=2023-01-01 HTTP/1.1​
Host:  rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260112T084409Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260112/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "rocketmq-cnng2324231212",​
  "GroupId": "my_group",​
  "GroupType": "TCP"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20260112164415124030007157D1****",​
    "Action": "CreateGroupAsync",​
    "Version": "2023-01-01",​
    "Service": "RocketMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

错误码

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

状态码	错误码	错误信息	说明
400	QuotaExceeded.GroupNumber	The number of group exceeds the limit.	Group 数量超出上限。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.02.13 18:31:53

这个页面对您有帮助吗？

有用

无用