tencent cloud



Last updated: 2023-07-05 15:57:45

1. API Description

Domain name for API request: ckafka.tencentcloudapi.com.

This API is used to set the consumer group (Groups) offset.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: ModifyGroupOffsets.
Version Yes String Common Params. The value used for this API: 2019-08-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Kafka instance ID
Group Yes String Kafka consumer group
Strategy Yes Integer Offset resetting policy. Meanings of the input parameters: 0: equivalent to the shift-by parameter, which indicates to shift the offset forward or backward by the value of the shift. 1: equivalent to by-duration, to-datetime, to-earliest, or to-latest, which indicates to move the offset to the specified timestamp. 2: equivalent to to-offset, which indicates to move the offset to the specified offset position
Topics.N No Array of String Indicates the topics to be reset. If this parameter is left empty, all topics will be reset
Shift No Integer When strategy is 0, this field is required. If it is above zero, the offset will be shifted backward by the value of the shift. If it is below zero, the offset will be shifted forward by the value of the shift. After a correct reset, the new offset should be (old_offset + shift). Note that if the new offset is smaller than the earliest parameter of the partition, it will be set to earliest, and if it is greater than the latest parameter of the partition, it will be set to latest
ShiftTimestamp No Integer Unit: ms. When strategy is 1, this field is required, where -2 indicates to reset the offset to the initial position, -1 indicates to reset to the latest position (equivalent to emptying), and other values represent the specified time, i.e., the offset of the topic at the specified time will be obtained and then reset. Note that if there is no message at the specified time, the last offset will be obtained
Offset No Integer Position of the offset that needs to be reset. When strategy is 2, this field is required
Partitions.N No Array of Integer List of partitions that need to be reset. If the topics parameter is not specified, reset partitions in the corresponding partition list of all topics. If the topics parameter is specified, reset partitions of the corresponding partition list of the specified topic list.

3. Output Parameters

Parameter Name Type Description
Result JgwOperateResponse Returned result
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Setting consumer group offsets

Input Example

&<Common request parameters>

Output Example

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

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.RepetitionValue The parameter already exists.
InvalidParameterValue.SubnetIdInvalid Invalid subnet ID.
InvalidParameterValue.SubnetNotBelongToZone The subnet is not in the zone.
InvalidParameterValue.VpcIdInvalid Invalid VPC ID.
InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
InvalidParameterValue.ZoneNotSupport The zone is not supported.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation.BatchDelInstanceLimit The batch instance deletion limit is reached.
UnsupportedOperation.OssReject Oss rejected the operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support