更新消费者分组的基础信息和消费重试策略。
接口说明
注意 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rocketmq:UpdateConsumerGroup | update | *ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId} |
| 无 |
请求语法
PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 待更新消费者分组所属的实例的 ID。 | rmq-cn-7e22on9**** |
| consumerGroupId | string | 是 | 待更新的消费者分组 ID。 | CID-TEST |
| body | object | 否 | 请求体。 | |
| remark | string | 否 | 更新后的消费者分组的备注信息。 | This is the remark for test. |
| deliveryOrderType | string | 是 | 更新后的消费者分组的投递顺序性。 参数取值如下：
| Concurrently |
| consumeRetryPolicy | object | 是 | 更新后的消费者分组的消费重试策略。更多信息，请参见 消费重试。 | |
| retryPolicy | string | 是 | DefaultRetryPolicy | |
| maxRetryTimes | integer | 否 | 最大重试次数。 | 16 |
| deadLetterTargetTopic | string | 否 | 死信 Topic。 消费者出现异常消费某条消息失败，且消息重试后依然未成功，消息将被投递至死信 Topic 中，以便后续进行业务恢复或回溯。更多信息，请参见消费重试与死信。 | DLQ_mqtest |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "C7F94090-3358-506A-97DC-34BC803C****",
"success": true,
"data": true,
"code": "InvalidDeliveryOrderType",
"message": "Parameter deliveryOrderType is invalid.",
"httpStatusCode": 400,
"dynamicCode": "DeliveryOrderType",
"dynamicMessage": "deliveryOrderType"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-11-17 | API 内部配置变更，不影响调用 | 查看变更详情 |