1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
设置Groups 消费分组offset
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
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，必须包含该字段。 |
| Partitions.N | 否 | Array of Integer | 需要重新设置的partition的列表，如果没有指定Topics参数。则重置全部topics的对应的Partition列表里的partition。指定Topics时则重置指定的topic列表的对应的Partitions列表的partition。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | JgwOperateResponse | 返回结果 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| 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拒绝该操作。 |