Domain name for API request: dts.intl.tencentcloudapi.com.
This API is used to reset the offset of the subscription consumer group. Call the DescribeConsumerGroups API to query the status of the consumer group, only when the status is Dead or Empty can this operation be executed. Otherwise, the reset will not be effective and the API will not return any error.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ResetConsumerGroupOffset. |
| Version | Yes | String | Common Params. The value used for this API: 2021-12-06. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SubscribeId | Yes | String | Subscription instance ID |
| TopicName | Yes | String | Subscribed Kafka topic |
| ConsumerGroupName | Yes | String | Consumer group name. The full name of the actual consumer group is in the form: consumer-grp-#{SubscribeId}-#{ConsumerGroupName}. |
| PartitionNos.N | Yes | Array of Integer | The partition number of offset needs to be modified. |
| ResetMode | Yes | String | Reset mode. Valid values: earliest (start consumption from the earliest position); latest (start consumption from the latest position); datetime (start consumption from the most recent checkpoint before the specified time). |
| ResetDatetime | No | String | When ResetMode is datetime, this field needs to be filled in, the format is: Y-m-d h:m:s. If not filled in, the default time is 0, and the effect is the same as earliest. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to reset the Kafka offset of a subscription task to a checkpoint around 2023-05-16 00:00:00.
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetConsumerGroupOffset
<Common request parameters>
{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | The CAM signature/authentication information is incorrect. |
| AuthFailure.AuthFailureError | Authentication failed. |
| FailedOperation | Operation failed. |
| FailedOperation.FailedOperationError | The operation failed. |
| InternalError | An internal error occurred. |
| InternalError.InternalErrorError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.InvalidParameterError | The parameter is invalid. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.InvalidParameterValueError | The parameter is invalid. |
| OperationDenied | The operation was denied. |
| OperationDenied.OperationDeniedError | The operation was denied. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.ResourceNotFoundError | The resource was not found. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnauthorizedOperation.UnauthorizedOperationError | The operation is unauthorized. |
| UnsupportedOperation | The operation is not supported. |
| UnsupportedOperation.UnsupportedOperationError | The operation is not supported. |
フィードバック