重置kafka offset

最近更新时间:2024-03-13 01:15:05

我的收藏

1. 接口描述

接口请求域名: dts.tencentcloudapi.com 。

本接口(ResetConsumerGroupOffset)用于重置订阅消费组的offset。调用DescribeConsumerGroups接口查询消费组状态,只有消费组状态为 Dead 或 Empty 才可以执行重置该操作。否则重置不会生效,接口也不会报错。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetConsumerGroupOffset。
Version String 公共参数,本接口取值:2021-12-06。
Region String 公共参数,详见产品支持的 地域列表
SubscribeId String 订阅实例id
示例值:subs-7l2ly86kao
TopicName String 订阅的kafka topic
示例值:topic-subs-7l2ly86kao-cdb-5jr9ms95
ConsumerGroupName String 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
示例值:consumer-grp-subs-7l2ly86kao-1
PartitionNos.N Array of Integer 需要修改offset的分区编号
ResetMode String 重置方式。枚举值为 earliest-从最开始位置开始消费;latest-从最新位置开始消费;datetime-从指定时间前最近的checkpoint开始消费
示例值:earliest
ResetDatetime String 当 ResetMode 为 datetime 时,该项需要填,格式为:Y-m-d h:m:s。如果不填,默认用0时间,效果与earliest相同。
示例值:2022-04-01 11:00:00

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 重置消费组offset

将一个订阅任务的kafka offset重置到2023-05-16 00:00:00附近的checkpoint

输入示例

POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetConsumerGroupOffset
<公共请求参数>

{
    "ConsumerGroupName": "consumer-grp-subs-635ns8r71g-1",
    "PartitionNos": [
        "0",
        "1",
        "2",
        "3"
    ],
    "ResetMode": "datetime",
    "ResetDatetime": "2023-05-16 00:00:00",
    "SubscribeId": "subs-635ns8r71g",
    "TopicName": "account-subs-635ns8r71g-1"
}

输出示例

{
    "Response": {
        "RequestId": "20461920-b18e-11ec-ae1a-cfe224f4f21f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.AuthFailureError 认证失败。
FailedOperation 操作失败。
FailedOperation.FailedOperationError 操作失败。
InternalError 内部错误。
InternalError.InternalErrorError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidParameterError 参数无效。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidParameterValueError 非法参数。
OperationDenied 操作被拒绝。
OperationDenied.OperationDeniedError 操作被拒绝。
ResourceNotFound 资源不存在。
ResourceNotFound.ResourceNotFoundError 资源未找到。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.UnauthorizedOperationError 未授权的操作。
UnsupportedOperation 操作不支持。
UnsupportedOperation.UnsupportedOperationError 不支持的操作。