ResetCheckpoint--日志服务-火山引擎

文档中心

立即注册

导航

日志服务

ResetCheckpoint

最近更新时间：2024.04.19 13:54:15首次发布时间：2023.09.27 17:28:20

调用 ResetCheckPoint 接口为指定消费组重置全部消费位点。

使用说明

此接口用于重置消费组的消费位点，与接口 ModifyCheckPoint 的区别在于，ModifyCheckPoint 仅支持重置消费组在指定日志分区上记录的消费位点，ResetCheckPoint 则会重置指定消费组的所有消费位点。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

说明

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

请求说明

请求方式：PUT
请求地址：https://tls-{Region}.ivolces.com/ResetCheckPoint

请求参数

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

Body

参数类型是否必选示例值描述

ProjectID String 是 c7****** 消费组订阅的日志项目 ID。

ConsumerGroupName String 是 my-consumer-group 待重置消费位点的消费组名称。

参数	类型	是否必选	示例值	描述
ProjectID	String	是	`c7******`	消费组订阅的日志项目 ID。
ConsumerGroupName	String	是	`my-consumer-group`	待重置消费位点的消费组名称。
Position	String	是	`begin`	新的消费位点，表示从指定位置开始消费数据。支持指定为： begin：从日志主题中最早的一条数据开始消费。 end：跳过所有历史数据，直接从日志主题上最近写入的一条数据开始消费。 Unixtime 10 位秒级时间戳。从过去某个指定时间点开始消费，该时间点以日志主题的数据保留时长为准。指定时间点重置消费点时，不支持指定为超出数据保留时长的历史时刻或未来时刻。

Position

String

是

begin

新的消费位点，表示从指定位置开始消费数据。支持指定为：

begin：从日志主题中最早的一条数据开始消费。
end：跳过所有历史数据，直接从日志主题上最近写入的一条数据开始消费。
Unixtime 10 位秒级时间戳。从过去某个指定时间点开始消费，该时间点以日志主题的数据保留时长为准。指定时间点重置消费点时，不支持指定为超出数据保留时长的历史时刻或未来时刻。

返回参数

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

请求示例

PUT https://tls-{Region}.ivolces.com/ResetCheckPoint HTTP/1.1
Content-Type: application/json
{
    "ProjectID": "c7************",
    "ConsumerGroupName": "my-consumer-group",
    "Position": "begin"
}

返回示例

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.	服务器内部错误。