Updates the basic information about and the consumption retry policy of a consumer group.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rocketmq:UpdateConsumerGroup | update | *ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId} |
| none |
Request syntax
PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the instance to which the consumer group belongs. | rmq-cn-7e22on9**** |
| consumerGroupId | string | Yes | The ID of the consumer group. | CID-TEST |
| body | object | No | The request body. | |
| remark | string | No | The new remarks on the consumer group. | This is the remark for test. |
| deliveryOrderType | string | Yes | The new message delivery order of the consumer group. Valid values:
| Concurrently |
| consumeRetryPolicy | object | Yes | The new consumption retry policy that you want to configure for the consumer group. For more information, see Consumption retry. | |
| retryPolicy | string | Yes | The retry policy. For more information, see Message retry. Valid values:
| DefaultRetryPolicy |
| maxRetryTimes | integer | No | The maximum number of retries. | 16 |
| deadLetterTargetTopic | string | No | The dead-letter topic. If a consumer still fails to consume a message after the message is retried for a specified number of times, the message is delivered to a dead-letter topic for subsequent business recovery or troubleshooting. For more information, see Consumption retry and dead-letter messages. | DLQ_mqtest |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "C7F94090-3358-506A-97DC-34BC803C****",
"success": true,
"data": true,
"code": "InvalidDeliveryOrderType",
"message": "Parameter deliveryOrderType is invalid.",
"httpStatusCode": 400,
"dynamicCode": "DeliveryOrderType",
"dynamicMessage": "deliveryOrderType"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2022-11-17 | The internal configuration of the API is changed, but the call is not affected | View Change Details |