UpdateConsumerGroup - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important Alibaba Cloud OpenAPI is a management API. You can use it to manage and query Alibaba Cloud service resources. This API is intended for management purposes only. Do not use this API for core data links that send and receive messages because this may introduce potential threats to your data links.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rocketmq:UpdateConsumerGroup

update

*ConsumerGroup

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

None

Request syntax

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

Path 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 to update.	CID-TEST

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
remark	string	No	The updated remarks for the consumer group.	This is the remark for test.
deliveryOrderType `deprecated`	string	No	This parameter cannot be modified. Valid values: Concurrently : Concurrent Orderly : Orderly	Concurrently
consumeRetryPolicy	object	Yes	The updated consumption retry policy for the consumer group. For more information, see Consumption retry.
retryPolicy	string	Yes	The retry policy. For more information, see Message retry. Valid values: FixedRetryPolicy: fixed interval retry. This policy applies only to orderly messages. DefaultRetryPolicy: backoff retry. This policy applies only to concurrent messages. Valid values: FixedRetryPolicy : Fixed interval retry DefaultRetryPolicy : Backoff retry	DefaultRetryPolicy
maxRetryTimes	integer	No	The maximum number of retries.	16
deadLetterTargetTopic	string	No	The dead-letter topic. If a message fails to be consumed after the maximum number of retries, the message is sent to a dead-letter topic. You can then perform business recovery or trace the message. For more information, see Consumption retry and dead-letter messages.	DLQ_mqtest
fixedIntervalRetryTime	integer	No	The fixed retry interval. Unit: seconds. This parameter is valid only if you set the retryPolicy parameter to FixedRetryPolicy. Value range: Concurrent delivery: 10 to 1800 Orderly delivery: 1 to 600	10
maxReceiveTps	integer	No	The maximum transactions per second (TPS) for message consumption.	1000

Response elements

Element	Type	Description	Example
	object	Result<boolean>
requestId	string	The request ID. Each request has a unique ID. You can use this ID to troubleshoot issues.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Indicates whether the request was successful.	true
data	boolean	The returned result.	true
code	string	The error code.	InvalidDeliveryOrderType
message	string	The error message.	Parameter deliveryOrderType is invalid.
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	DeliveryOrderType
dynamicMessage	string	The dynamic error message.	deliveryOrderType

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.