ModifyGroupOffsets

Last updated: 2025-11-21 20:32:39

ModifyGroupOffsets

Last updated: 2025-11-21 20:32:39

1. API Description

Domain name for API request: ckafka.intl.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	ckafka cluster instance Id. obtain through the API DescribeInstances.
Group	Yes	String	Consumer group name. obtain through the API DescribeConsumerGroup.
Strategy	Yes	Integer	Reset offset strategy. parameter meaning: 0. align with the shift-by parameter, move the offset forward or backward by shift entries. 1. alignment reference (by-duration, to-datetime, to-earliest, to-latest), move the offset to the specified timestamp position. 2. alignment reference (to-offset), move the offset to the specified offset position.
Topics.N	Yes	Array of String	Specifies the topic name list that needs to 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	In milliseconds. when strategy is 1, must include this field. among them, -2 means reset offset to the start position, -1 means reset to the latest position (equivalent to clearing), other values represent the specified time. obtain the offset at the specified time in the topic and reset. notably, if no message exists at the specified time, get the last offset.
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, 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.

4. Example

Example1 Set the Consumer Group (Groups) offset

Input Example

https://ckafka.intl.tencentcloudapi.com/?Action=ModifyGroupOffsets
&InstanceId=ckafka-test
&Group="group"
&Topics.0=topic-test
&Strategy=1
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "ReturnCode": "0",
            "ReturnMessage": "SUCCESS",
            "Data": {
                "FlowId": 0
            }
        },
        "RequestId": "36713f94-d07d-4b96-babf-42d139276f23"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud