Resetting the Consumer Offset

Updated on 2022-09-14 GMT+08:00

View PDF

This API is used to reset the consumer offset.

POST /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Engine type. Value: reliability. Default: reliability
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.
group_id	Yes	String	Consumer group name.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
topic	No	String	Topic to be reset.
timestamp	No	Number	Reset time.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
queues	Array of queues objects	Queues to be reset.

**Table 4** queues
Parameter	Type	Description
broker_name	String	Broker where the queue is located.
queue_id	Integer	Queue ID.
timestamp_offset	Integer	Target offset.

Resetting the consumer offset

POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset

Status code: 200

Consumer offset reset.

{
  "queues" : [ {
    "broker_name" : "broker-1",
    "queue_id" : 0,
    "timestamp_offset" : 0
  } ]
}

Status Code	Description
200	Consumer offset reset.

Parent topic: Consumer Group Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel