You need to enable JavaScript to run this app.
导航
ResetConsumedOffsets - 重置消费位点
最近更新时间:2024.09.26 15:55:18首次发布时间:2023.03.30 19:59:26

调用 ResetConsumedOffsets 重置消费者组的消费位点。

使用说明

此接口用于重置指定消费组的消费位点,改变订阅者当前的消费位置,即直接从某个指定时间点、最新 offset 位点或指定 offset 位点来消费消息。

说明

  • 消息队列 Kafka版不支持在线重置消费位点,在重置消费位点之前,必须停止 Consumer Group 中的所有消费者客户端,确保 Group 的状态为 Empty。
  • 停止消费者客户端后,需要经过指定的超时时间,服务端才认为 Consumer 真正下线。其中超时时间为 ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG 配置的时间,默认 10000ms。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

ResetConsumedOffsets

要执行的操作,取值:ResetConsumedOffsets。

Version
String

2022-05-01

API的版本,取值:2022-05-01。

InstanceId
String

kafka-cnngbnntswg1****

需要重置消费位点的实例 ID。

GroupId
String

my_group

需要重置消费位点的消费组 ID。

ResetOffsetsInfo
Array of Object

--

需要重置的消费位点信息。

返回参数

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

请求示例

POST /?Action=ResetConsumedOffsets&Version=2022-05-01 HTTP/1.1
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-cnng1si21igu****",
  "GroupId":"Group",
  "ResetOffsetsInfo": {
      "TopicName": "test",
      "PartitionId":0,
      "ResetType": "Offset",
      "ResetOffset": -1
  }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230227211906E9F948120F87D27F1AEE",
        "Action": "ResetConsumedOffsets",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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

状态码
错误码
错误信息
说明
400
InvalidParameter
The specified parameter is not valid.

参数值无效。

403
OperationDenied.InvalidInstanceStatus
The operation is not valid for the current status of the instance.

当前实例状态不允许执行该操作。

403
OperationDenied.AccountNotAuthorized
You are not authorized to perform this operation.

您不具备相关权限 ,请授权或切换账号后重试。

404
InvalidInstanceId.NotFound
The specified Instance ID does not exist.

实例不存在。

404
InvalidGroupId.NotFound
The specified consumer group does not exist.

Group不存在。

404
InvalidTopicName.NotFound
The specified topic does not exist.

Topic不存在。

500
InternalError
The request failed due to some unknown error, exception or failure.

内部错误,请稍后重试。