OnsConsumerResetOffset - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Resets a consumer offset to a specified timestamp for a consumer group.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

You can call this operation to clear accumulated messages or reset a consumer offset to a specified timestamp. You can use one of the following methods to clear accumulated messages:

Clear all accumulated messages in a specified topic.
Clear the messages that were published to the specified topic before a specified point in time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 Resources is 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
mq:ResetConsumerOffset	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the consumer group whose dead-letter message you want to query.	GID_test_consumer_id
Topic	string	Yes	The name of the topic for which you want to reset the consumer offset.	test-mq-topic
Type	integer	Yes	The method that you want to use to clear accumulated messages. Valid values: 0: All accumulated messages are cleared. Messages that are not consumed are ignored. Consumers in the specified consumer group consume only messages that are published to the topic after the specified point in time. If "reconsumeLater" is returned, the accumulated messages are not cleared because the system is retrying to resend the messages to consumers. 1: The messages that were published to the topic before the specified point in time are cleared. You must specify a point in time. Consumers in the specified consumer group consume only the messages that are published to the topic after the specified point in time. You can specify a point in time from the earliest point in time when a message was published to the topic to the most recent point in time when a message was published to the topic. Points in time that are not within the allowed time range are invalid.	1
ResetTimestamp	long	No	The timestamp to which you want to reset the consumer offset. This parameter takes effect only when the Type parameter is set to 1. Unit: milliseconds.	1591153871000
InstanceId	string	Yes	The ID of the instance to which the consumer group belongs.	MQ_INST_111111111111_DOxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	D52C68F8-EC5D-4294-BFFF-1A6A25AF****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history

Reset the consumer offset of a consumer group in the console

You can also reset the consumer offset for a consumer group in the ApsaraMQ for RocketMQ console.**** For more information, see Reset consumer offsets.