Updated on 2026-11-03 GMT+08:00

Querying the Offset of a Consumer Group

Function

This API is used to query the offset of a consumer group.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}/message-offset

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Definition

Message engine.

Constraints

N/A

Range

kafka.

Default Value

N/A

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. To obtain it, call the API for querying all instances.

Constraints

N/A

Range

N/A

Default Value

N/A

group

Yes

String

Definition

Consumer group ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

topic

Yes

String

Definition

Topic name.

Constraints

Mandatory for querying the offset of a consumer group.

Range

N/A

Default Value

N/A

partition

No

String

Definition

Partition name.

Constraints

N/A

Range

N/A

Default Value

N/A

offset

No

String

Definition

Offset from which the query starts.

Constraints

N/A

Range

≥ 0

Default Value

0.

limit

No

String

Definition

Number of records returned.

Constraints

N/A

Range

1–50

Default Value

10.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

group_message_offsets

Array of GroupMessageOffsetsDetailEntity objects

Definition

Consumer group offset details.

total

Integer

Definition

Total number of partitions.

Range

N/A

Table 4 GroupMessageOffsetsDetailEntity

Parameter

Type

Description

partition

Integer

Definition

Partition.

Range

N/A

message_current_offset

Integer

Definition

Current offset.

Range

N/A

topic

String

Definition

Topic name.

Range

N/A

message_log_start_offset

Integer

Definition

Start offset.

Range

N/A

lag

Integer

Definition

Number of remaining messages that can be consumed, that is, the number of accumulated messages.

Range

N/A

message_log_end_offset

Integer

Definition

End offset.

Range

N/A

consumer_id

String

Definition

Consumer ID.

Range

N/A

host

String

Definition

Host name.

Range

N/A

client_id

String

Definition

Client ID.

Range

N/A

Example Requests

Querying the offset of a consumer group

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}/message-offset?topic=topic-189717555

Example Responses

Status code: 200

{
  "group_message_offsets" : [ {
    "partition" : 0,
    "lag" : 0,
    "topic" : "topic-189717555",
    "message_current_offset" : 0,
    "message_log_start_offset" : 0,
    "message_log_end_offset" : 0,
    "consumer_id" : "",
    "host" : "",
    "client_id" : ""
  } ],
  "total" : 1
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;


public class ListInstanceConsumerGroupMessageOffsetSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        ListInstanceConsumerGroupMessageOffsetRequest request = new ListInstanceConsumerGroupMessageOffsetRequest();
        request.withEngine("{engine}");
        request.withInstanceId("{instance_id}");
        request.withGroup("{group}");
        try {
            ListInstanceConsumerGroupMessageOffsetResponse response = client.listInstanceConsumerGroupMessageOffset(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListInstanceConsumerGroupMessageOffsetRequest()
        request.engine = "{engine}"
        request.instance_id = "{instance_id}"
        request.group = "{group}"
        response = client.list_instance_consumer_group_message_offset(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := kafka.KafkaClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := kafka.NewKafkaClient(hcClient)

    request := &model.ListInstanceConsumerGroupMessageOffsetRequest{}
	request.Engine = "{engine}"
	request.InstanceId = "{instance_id}"
	request.Group = "{group}"
	response, err := client.ListInstanceConsumerGroupMessageOffset(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.