ResetConsumeOffset - - Alibaba Cloud Documentation Center

Resets the consumer offset of a consumer group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
rocketmq:ResetConsumeOffset	update	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	none	none

Request syntax

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

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