Resetting the Consumer Offset
Function
This API is used to reset the consumer offset.
URI
POST /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset
|
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. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
topic |
No |
String |
Topic to be reset. |
|
timestamp |
No |
Number |
Reset time. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
queues |
Array of queues objects |
Queues to be reset. |
Example Requests
Resetting the consumer offset
POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset
Example Responses
Status code: 200
Consumer offset reset.
{
"queues" : [ {
"broker_name" : "broker-1",
"queue_id" : 0,
"timestamp_offset" : 0
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Consumer offset reset. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
