Querying the Offset of a Consumer Group

Updated on 2025-03-07 GMT+08:00

View PDF

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

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
engine	Yes	String	Message engine.
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
group	Yes	String	Consumer group name.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
topic	No	String	Topic name.
partition	No	String	Partition name.
offset	No	String	Offset.
limit	No	String	Maximum value.

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
group_message_offsets	Array of GroupMessageOffsetsDetailEntity objects	Consumer group offset details.
total	Integer	Total.

Querying the offset of a consumer group

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

Status code: 200

Successful

{
  "group_message_offsets" : [ ],
  "total" : 0
}

Status Code	Description
200	Successful

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel