接口请求域名： dts.intl.tencentcloudapi.com 。
本接口(ResetConsumerGroupOffset)用于重置订阅消费组的offset。调用DescribeConsumerGroups接口查询消费组状态，只有消费组状态为 Dead 或 Empty 才可以执行重置该操作。否则重置不会生效，接口也不会报错。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ResetConsumerGroupOffset。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SubscribeId | 是 | String | 订阅实例id，可通过DescribeSyncJobs接口获取。 |
| TopicName | 是 | String | 订阅的kafka topic，可通过DescribeSyncJobs接口获取。 |
| ConsumerGroupName | 是 | String | 消费组名称。实际的消费组全称形如：consumer-grp-#{SubscribeId}-#{ConsumerGroupName}。可通过DescribeConsumerGroups接口获取。 |
| PartitionNos.N | 是 | Array of Integer | 需要修改offset的分区编号，可通过DescribeOffsetByTime接口获取。 |
| ResetMode | 是 | String | 重置方式。枚举值为 earliest-从最开始位置开始消费；latest-从最新位置开始消费；datetime-从指定时间前最近的checkpoint开始消费 |
| ResetDatetime | 否 | String | 当 ResetMode 为 datetime 时，该项需要填，格式为：Y-m-d h:m:s。如果不填，默认用0时间，效果与earliest相同。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
将一个订阅任务的kafka offset重置到2023-05-16 00:00:00附近的checkpoint
POST / HTTP/1.1
Host: dts.intl.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"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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 | 不支持的操作。 |
文档反馈