tencent cloud



Last updated: 2023-03-22 17:06:18

1. API Description

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

This API is used to batch modify consumer group offsets.

A maximum of 20 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: BatchModifyGroupOffsets.
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.
GroupName Yes String Consumer group name.
InstanceId Yes String Instance name.
Partitions.N Yes Array of Partitions Partition information.
TopicName.N No Array of String Name of the specified topic. Default value: names of all topics.

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 in batches

This example shows you how to batch set consumer group offsets.

Input Example

Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchModifyGroupOffsets
<Common request parameters>

    "InstanceId": "xx",
    "GroupName": "xx",
    "TopicName": [
    "Partitions": [
            "Partition": 0,
            "Offset": 0

Output Example

    "Response": {
        "Result": {
            "ReturnCode": "0",
            "ReturnMessage": "ok",
            "Data": "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.WrongAction The value of the Action parameter is incorrect.
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