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

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Engine type. Value: reliability.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
group_id	Yes	String	Consumer group name.

Request Parameters

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

Response Parameters

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	Long	Target offset.

Example Requests

Resetting consumer offset of topic_01 to a specified time point

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

{
  "topic" : "topic_01",
  "timestamp" : 1662652800000
}

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.

Parent topic: Consumer Group Management

Предыдущая статья

Querying the Consumer Group List or Details

Следующая статья

Topic Management

Была ли эта статья полезна?

Поддержка Юридические документы