ResetConsumeOffset - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Resets the consumer offset of a consumer group.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request 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
body	object	No	The request body.
resetType	string	No	The method that is used to reset the consumer offset. Valid values: LATEST_OFFSET and SPECIFIED_TIME.	LATEST_OFFSET
resetTime	string	No	The time when the consumer offset is reset.	2023-03-22 12:17:08

Response parameters

Parameter	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

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history