调用GetConsumerGroup获取消费者分组详情-云消息队列 RocketMQ 版-阿里云

获取某个指定消费者分组的详细信息。

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:GetConsumerGroup

get

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
instanceId	string	是	待查询消费者分组所属的实例的 ID。	rmq-cn-7e22ody****
consumerGroupId	string	是	待查询消费者分组的 ID。	CID-TEST

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	Result
requestId	string	请求 ID，每个请求的 ID 都是唯一的，可用于排查和定位问题。	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	执行结果是否成功。	true
data	object	返回结果。
regionId	string	实例所属的地域 ID。	cn-hangzhou
instanceId	string	消费者分组所属的实例的 ID。	rmq-cn-7e22ody****
consumerGroupId	string	消费者分组的 ID。	CID-TEST
status	string	消费者分组的状态。枚举值： RUNNING : 运行中 CREATING : 创建中	RUNNING
remark	string	消费者分组的备注信息。	This is the remark for test.
createTime	string	消费者分组的创建时间。	2022-08-01 20:05:50
updateTime	string	消费者分组的最后更新时间。	2022-08-01 20:05:50
deliveryOrderType	string	消费者分组的投递顺序性。枚举值： Concurrently : 并发投递 Orderly : 顺序投递	Concurrently
consumeRetryPolicy	object	消费者分组的消费重试策略。更多信息，请参见消费重试。
retryPolicy	string	重试策略类型。枚举值： FixedRetryPolicy : 固定间隔重试 DefaultRetryPolicy : 阶梯退避重试	DefaultRetryPolicy
maxRetryTimes	integer	最大重试次数。	16
deadLetterTargetTopic	string	死信 Topic。消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信 Topic 中，以便后续进行业务恢复或回溯。更多信息，请参见消费重试与死信。	DLQ_mqtest
fixedIntervalRetryTime	integer	固定重试间隔，取之范围，单位：秒 Concurrently(并发投递)：10-1800 Orderly(顺序投递): 1-600	20
maxReceiveTps	integer	消费消息 tps 上限	2000
messageModel	string	消费模式： CLUSTERING：集群消费 LITE_SELECTIVE：LITE_SELECTIVE	LITE_SELECTIVE
topicName	string	lite 类型的 topicName	test1
code	string	错误码。	InvalidConsumerGroupId
message	string	错误信息。	Parameter consumerGroupId is invalid.
httpStatusCode	integer	HTTP 状态码。	400
dynamicCode	string	动态错误码。	ConsumerGroupId
dynamicMessage	string	动态错误信息。	consumerGroupId

示例

正常返回示例

JSON格式

{
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "status": "RUNNING",
    "remark": "This is the remark for test.",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "deliveryOrderType": "Concurrently",
    "consumeRetryPolicy": {
      "retryPolicy": "DefaultRetryPolicy",
      "maxRetryTimes": 16,
      "deadLetterTargetTopic": "DLQ_mqtest",
      "fixedIntervalRetryTime": 20
    },
    "maxReceiveTps": 2000,
    "messageModel": "LITE_SELECTIVE",
    "topicName": "test1"
  },
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

错误码

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

变更历史

更多信息，参考变更详情。