You need to enable JavaScript to run this app.
导航

ResetCheckPoint

最近更新时间2023.11.13 16:31:41

首次发布时间2023.09.27 17:28:20

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

使用说明

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

说明

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

URI

请求方法
PUT

URI

https://tls-{Region}.ivolces.com/ResetCheckPoint

传输协议

HTTPS

请求参数

参数
参数类型
是否必选
示例值
说明

ProjectID

String

c7******

消费组订阅的日志项目 ID。

ConsumerGroupName

String

my-consumer-group

待重置消费位点的消费组名称。

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 
...
{}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。