DescribeGroupOffsets

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-18 17:38:21

Download PDF

1. API Description

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

This API is used to get the consumer group 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeGroupOffsets.
Version	Yes	String	Common parameter. The value used for this API: 2019-08-19.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	(Filter) filter by instance ID
Group	Yes	String	Kafka consumer group
Topics.N	No	Array of String	Array of the names of topics subscribed to by a group. If there is no such array, this parameter means the information of all topics in the specified group
SearchWord	No	String	Fuzzy match by `topicName`
Offset	No	Integer	Offset position of this query. Default value: 0
Limit	No	Integer	Maximum number of results to be returned in this request. Default value: 50. Maximum value: 50

3. Output Parameters

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

4. Example

Example1 Getting consumer group offsets

Input Example

https://ckafka.tencentcloudapi.com/?Action=DescribeGroupOffsets
&InstanceId=10
&Group="group"
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "TotalCount": 1,
      "TopicList": [
        {
          "Topic": "test",
          "Partitions": [
            {
              "Partition": 0,
              "Offset": 22689638,
              "Metadata": "",
              "ErrorCode": 0,
              "LogEndOffset": 207927929,
              "Lag": 185238291
            }
          ]
        }
      ]
    },
    "RequestId": "fd9afa97-cc0f-4ea7-9da8-63914a0877e1"
  }
}

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
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.

Recent Pages