ResetConsumeOffset API to reset consumer group offsets - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Resets the consumer offset of a specified consumer group to change the position from which consumers start reading messages. You can roll back to a specific offset for reconsumption when faults occur, or skip to the latest offset to bypass accumulated messages.

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:ResetConsumeOffset

update

*ConsumerGroup

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-tl32ue44x0g
consumerGroupId	string	Yes	The consumer group ID.	dolphin_status
topicName	string	Yes	The topic name.	AMZN_REPORT_TOPIC

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
resetType	string	No	The method used to reset the consumer offset. Valid values: LATEST_OFFSET and SPECIFIED_TIME. Valid values: SPECIFIED_TIME : 从指定时间的位点开始消费 LATEST_OFFSET : 从最新位点开始消费	LATEST_OFFSET
resetTime	string	No	The time to which the consumer offset is reset.	2023-03-22 12:17:08

Response elements

Element	Type	Description	Example
	object	Result
requestId	string	The request ID.	F9A95891-EAD4-5A2B-8A30-676CD18921AF
success	boolean	Indicates whether the request is successful.	true
code	string	The returned error code.	MissingInstanceId
message	string	The returned error message.	The instance cannot be found.
httpStatusCode	integer	The returned HTTP status code.	200
dynamicCode	string	The returned dynamic error code.	InstanceId
dynamicMessage	string	The returned dynamic error message.	instanceId

Examples

Success response

JSON format

{
  "requestId": "F9A95891-EAD4-5A2B-8A30-676CD18921AF",
  "success": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.