文档

CreateConsumerGroup - 创建消费者分组

更新时间:

创建云消息队列 RocketMQ 版的消费者分组(ConsumerGroup)。消费者分组是云消息队列 RocketMQ 版系统中承载多个消费行为一致的消费者的负载均衡分组。消费者需要通过指定消费者分组订阅相关的主题来实现消息订阅。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rocketmq:CreateConsumerGroupcreate
  • ConsumerGroup
    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

请求语法

POST /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1

请求参数

名称类型必填描述示例值
instanceIdstring

待创建的消费者分组所属的实例 ID。

rmq-cn-7e22ody****
consumerGroupIdstring

待创建的消费者分组的 ID。用于标识消费者分组,全局唯一。

取值说明如下:

  • 字符限制:支持字母 a~z 或 A~Z、数字 0~9 以及下划线(_)、短划线(-)。
  • 长度限制:1~60 个字符。

保留字符限制,请参见参数限制

GID_test_groupId
bodyobject

请求体对象。

remarkstring

待创建消费者分组的备注信息。

This is the remark for test.
deliveryOrderTypestring

待创建消费者分组的投递顺序性。

参数取值如下:

  • Concurrently:并发投递
  • Orderly:顺序投递
Concurrently
consumeRetryPolicyobject

待创建消费者分组的消费重试策略。更多信息,请参见 消费重试

maxRetryTimesinteger

最大重试次数。

16
retryPolicystring

重试策略类型。更多信息,请参见消息重试

参数取值如下:

  • FixedRetryPolicy:固定间隔重试
  • DefaultRetryPolicy:阶梯退避重试
DefaultRetryPolicy
deadLetterTargetTopicstring

死信 Topic。

消费者出现异常消费某条消息失败,且消息重试后依然未成功,消息将被投递至死信 Topic 中,以便后续进行业务恢复或回溯。更多信息,请参见消费重试与死信

DLQ_mqtest

返回参数

名称类型描述示例值
object

Result

requestIdstring

请求 ID,每个请求的 ID 都是唯一的,可用于排查和定位问题。

AF9A8B10-C426-530F-A0DD-96320B39****
successboolean

执行结果是否成功。

true
databoolean

返回结果。

true
codestring

错误码。

InvalidConsumerGroupId
messagestring

错误信息。

Parameter consumerGroupId is invalid.
httpStatusCodeinteger

HTTP 状态码。

400
dynamicCodestring

动态错误码。

ConsumerGroupId
dynamicMessagestring

动态错误信息。

consumerGroupId

示例

正常返回示例

JSON格式

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-11-17API 内部配置变更,不影响调用查看变更详情