You need to enable JavaScript to run this app.
Torch Log Service

Torch Log Service

Copy page
Download PDF
Consumer group management API
ResetCheckpoint
Copy page
Download PDF
ResetCheckpoint
Modify the shard consumption progress of the current consumer group​
Request instructions​
  • Request method: PUT​
  • Request URL: https://{tls-endpoint}/ResetCheckPoint​
Request parameters​
The table below lists only parameters specific to this API and some common parameters. For more information, see public parameters.​
Body​
​
Parameter​
Type​
Required​
Example value​
Description​
ProjectID​
String​
Yes​
4a9bd4bd-53f1-43ff-b88a-64ee1be5****​
ID of the log project subscribed by the consumer group.​
ConsumerGroupName​
String​
Yes​
consumerGroupA​
Name of the consumer group to reset the consumption position.​
Position​
String​
Yes​
1690340959​
New consumer position, indicating the starting point for data consumption. Supported specifications:​
  • begin: Start consuming from the earliest log entry in the topic.​
  • end: Skip all historical data and start consuming from the most recent log entry written to the topic.​
  • 10-digit Unixtime in seconds. Start consuming from a specified time in the past, which is determined by the data retention period of the log topic. When resetting the consumption point to a specified time, you cannot choose a time that exceeds the data retention period or a future time.​
​
Response parameters​
This interface has no unique return parameters. For more information, see Return Structure.​
Sample request​
​
PUT https://{tls-endpoint}/ResetCheckPoint HTTP/1.1​
Content-Type: application/json​
{​
"ProjectID": "c7************",​
"ConsumerGroupName": "my-consumer-group",​
"Position": "begin"​
}​
​
Sample response​
​
HTTP/1.1 200 OK​
Content-Type: application/json; charset=utf-8​
​
Error Code​
The following table lists the error codes related to the interface and business logic. For common error codes, refer to the Common Error Codes documentation.​
​
HTTP Status Code​
Error Code​
Error message​
Description​
400​
InvalidArgument​
Invalid argument key %s, value %s, please check argument.​
Invalid parameter.​
500​
InternalServerError​
We encountered an unexpected server error, please try again later.​
Internal server error.​
​
Last updated: 2025.10.28 18:42:01