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

ModifyCheckPoint

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

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

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

使用说明

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

说明

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

URI

请求方法
PUT

URI

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

传输协议

HTTPS

请求参数

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

ProjectID

String

c7******

待修改消费进度的日志项目 ID。

TopicID

String

b6******

待修改消费进度的日志主题 ID。

ShardID

Integer

0

待修改消费进度的 Shard ID。

ConsumerGroupName

String

my-consumer-group

待修改 CheckPoint 的消费组名称。

Checkpoint

String

M********

消费位点,即消费游标。

响应参数


示例

请求示例

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

错误码

错误码(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.

服务器内部错误。