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).

URI

PUT /v2/kafka/{project_id}/instances/{instance_id}/groups/{group}/reset-message-offset

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	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	Resetting 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 offset. If this offset is later than the current largest offset, the offset will be reset to the latest offset. Either message_offset or timestamp must be specified.
timestamp	No	Long	Specified time that the offset is to be reset to. The value is a Unix timestamp, in millisecond. If this time is earlier than the current earliest timestamp, the offset will be reset to the earliest timestamp. If this time is later than the current largest timestamp, the offset will be reset to the latest timestamp. Either message_offset or timestamp must be specified.

Response Parameters

None

Example Requests

Resetting consumer group offset to the specified position

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

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

Resetting consumer group offset to the specified time

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

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

Example Responses

None

Status Codes

Status Code	Description
204	Successful

Error Codes

See Error Codes.

Parent topic: Instance Management

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

Modifying User or Client Quotas

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

Querying Kafka Instance Rebalancing Log Details

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

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