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

ModifyCheckpoint

最近更新时间2024.04.19 13:54:15

首次发布时间2023.09.27 12:24:24

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

使用说明

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

注意事项

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

请求说明

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

请求参数

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

Body

参数类型是否必选示例值描述
ProjectIDStringc7******待修改 CheckPoint 的日志项目 ID。
TopicIDStringb6******待修改 CheckPoint 的日志主题 ID。
ShardIDInteger0待修改 CheckPoint 的 Shard ID。
ConsumerGroupNameStringmy-consumer-group待修改 CheckPoint 的消费组名称。
CheckpointStringM********消费位点,即消费进度。

返回参数

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

请求示例

PUT https://tls-{Region}.ivolces.com/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 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。