OnsConsumerResetOffset - Reset consumer group offset - ApsaraMQ for RocketMQ

Operation description

Note

Alibaba Cloud API operations are designed for resource management only. Do not use them in the core messaging data path. Otherwise, system risks may occur.

Use this operation to clear accumulated messages or reset a consumer offset to a specified timestamp. Two clearing methods are available:

Clear all accumulated messages in a topic.
Clear messages published before a specified point in time.

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

mq:ResetConsumerOffset

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

None

mq:OnsInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The consumer group ID whose dead-letter messages you want to query.	GID_test_consumer_id
Topic	string	Yes	The topic for which to reset the consumer offset.	test-mq-topic
Type	integer	Yes	The method to clear accumulated messages. Valid values: 0: Clears all accumulated messages. Unconsumed messages are skipped. The consumer group consumes only messages published to the topic after the specified point in time. If "reconsumeLater" is returned, accumulated messages are not cleared because the system is retrying to resend messages to consumers. 1: Clears messages published before the specified timestamp. You must specify a point in time. The consumer group consumes only messages published after that time. The specified time must fall between the earliest and latest message publish times for the topic. Values outside this range are invalid.	1
ResetTimestamp	integer	No	The timestamp to reset the consumer offset to. Takes effect only when Type is set to 1. Unit: milliseconds.	1591153871000
InstanceId	string	No	The instance ID that the consumer group belongs to.	MQ_INST_111111111111_DOxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. This is a common parameter. Each request has a unique ID that you can use for troubleshooting.	D52C68F8-EC5D-4294-BFFF-1A6A25AF****

Examples

Success response

JSON format

{
  "RequestId": "D52C68F8-EC5D-4294-BFFF-1A6A25AF****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.