文档中心

日志服务

请输入

消费组管理

ModifyCheckpoint

调用 ModifyCheckPoint 接口为指定消费组重置指定分区的消费位点。

使用说明

此接口用于重置消费组的消费位点，与接口 ResetCheckPoint 的区别在于，ModifyCheckPoint 仅支持重置消费组在指定日志分区上记录的消费位点，ResetCheckPoint 则会重置指定消费组的所有消费位点。

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

注意事项

重置消费位点之前，应关闭对应的消费进程，否则消费位点重置失败。

请求说明

请求方式：PUT

请求地址：https://{tls-endpoint}/ModifyCheckpoint

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
ProjectID	String	是	c7******	待修改 CheckPoint 的日志项目 ID。
TopicID	String	是	b6******	待修改 CheckPoint 的日志主题 ID。
ShardID	Integer	是	0	待修改 CheckPoint 的 Shard ID。
ConsumerGroupName	String	是	my-consumer-group	待修改 CheckPoint 的消费组名称。
Checkpoint	String	是	M********	消费的位点，即消费进度。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

PUT https://{tls-endpoint}/ModifyCheckpoint HTTP/1.1​
Content-Type: application/json​
{​
    "ProjectID": "c7************",​
    "TopicID": "b6********",​
    "ShardID": 0,​
    "ConsumerGroupName": "my-consumer-group",​
    "Checkpoint": "NjUwYzRkYTgtMi0wMDAwMDAwMDAwMDAwMzE0LTAwNGY1LTA="​
}​

返回示例

HTTP/1.1 200 OK​
Content-Type: application/json; charset=utf-8​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。

最近更新时间：2025.10.14 14:20:53

这个页面对您有帮助吗？

有用

无用