设置Groups 消费分组offset
最近更新时间: 2025-02-18 17:50:23
1. 接口描述
接口请求域名： ckafka.api3.fincloud.tencent.cn。
设置Groups 消费分组offset
默认接口请求频率限制：100次/秒。
接口更新时间：2019-12-09 10:54:37。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyGroupOffsets |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-08-19 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | kafka实例id |
| Group | 是 | 否 | String | kafka 消费分组 |
| Strategy | 是 | 否 | Int64 | 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置 |
| Topics | 否 | 否 | Array of String | 表示需要重置的topics， 不填表示全部 |
| Shift | 否 | 否 | Int64 | 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest |
| ShiftTimestamp | 否 | 否 | Int64 | 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。 |
| Offset | 否 | 否 | Int64 | 需要重新设置的offset位置。当strategy为2，必须包含该字段。 |
| Partitions | 否 | 否 | Array of Uint64 | 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | JgwOperateResponse | 返回结果 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue.RepetitionValue | |
| InvalidParameterValue.WrongAction | |
| InvalidParameterValue.InstanceNotExist | |
| UnauthorizedOperation | |
| UnsupportedOperation.OssReject | |
| InvalidParameterValue.SubnetNotBelongToZone | |
| InvalidParameterValue.VpcIdInvalid | |
| InvalidParameterValue.SubnetIdInvalid | |
| InvalidParameterValue.ZoneNotSupport | |
| UnsupportedOperation.BatchDelInstanceLimit | |
| InternalError | |
| ResourceUnavailable |