设置Groups 消费分组offset

最近更新时间:2020-03-04 17:55:47

1. 接口描述

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

设置Groups 消费分组offset

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:ckafka.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyGroupOffsets。
Version String 公共参数,本接口取值:2019-08-19。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String kafka实例id
Group String kafka 消费分组
Strategy Integer 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
Topics.N Array of String 表示需要重置的topics, 不填表示全部
Shift Integer 当strategy为0时,必须包含该字段,可以大于零代表会把offset向后移动shift条,小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift),需要注意的是如果新的offset小于partition的earliest则会设置为earliest,如果大于partition 的latest则会设置为latest
ShiftTimestamp Integer 单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的时,如果指定的时间不存在消息,则获取最末尾的offset。
Offset Integer 需要重新设置的offset位置。当strategy为2,必须包含该字段。

3. 输出参数

参数名称 类型 描述
Result JgwOperateResponse 返回结果
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设置Groups 消费分组offset

输入示例

https://ckafka.tencentcloudapi.com/?Action=ModifyGroupOffsets
&InstanceId=10
&Group="group"
&Strategy=0
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": {
      "ReturnCode": "0",
      "ReturnMessage": "ok"
    },
    "RequestId": "ae362db8-81f6-4441-b0cc-1f6ffa31127e"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InstanceNotExist 实例不存在。
InvalidParameterValue.RepetitionValue 已存在相同参数。
InvalidParameterValue.SubnetIdInvalid 无效的子网id
InvalidParameterValue.SubnetNotBelongToZone 子网不属于zone
InvalidParameterValue.VpcIdInvalid 无效的 Vpc Id
InvalidParameterValue.WrongAction Action参数取值错误。
InvalidParameterValue.ZoneNotSupport zone不支持
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.BatchDelInstanceLimit 批量删除实例限制
UnsupportedOperation.OssReject Oss拒绝该操作