Resetting Consumer Group Offset to the Specified Position

Function

Kafka instances do not support resetting the consumer offset online. Before resetting, stop the client for which the offset is to be reset. After a client is stopped, the server considers the client offline only after the time period specified in ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG (1000 ms by default).

This API is out-of-date and may not be maintained in the future. Use the API described in Resetting Consumer Group Offset to the Specified Position.

Call Method

For details, see How to Call an API.

URI

POST /v2/{project_id}/instances/{instance_id}/management/groups/{group}/reset-message-offset

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
group	Yes	String	Consumer group name.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
topic	No	String	Topic name.
partition	Yes	Integer	Partition number. The default value is -1, indicating that all partitions are reset.
message_offset	No	Long	This parameter resets consumer group offset to the specified position. If this position is earlier than the current earliest offset, the offset will be reset to the earliest position. If this position is later than the current latest offset, the offset will be reset to the latest position. Either message_offset or timestamp must be specified.
timestamp	No	Long	This parameter resets consumer group offset to the specified time. The value is a UNIX timestamp, in millisecond. If this timestamp is earlier than the current earliest timestamp, the offset will be reset to the earliest timestamp. If this timestamp is later than the current latest timestamp, the offset will be reset to the latest timestamp. Either message_offset or timestamp must be specified.

Response Parameters

None

Example Requests

A consumer group offset is reset to the specified position.

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

{
  "topic" : "test",
  "partition" : 0,
  "message_offset" : 10
}

A consumer group offset is reset to the specified time.

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

{
  "topic" : "test",
  "partition" : 0,
  "timestamp" : 1571812144000
}