Updated on 2023-08-29 GMT+08:00

Querying a Specific Consumer Group

Function

This API is used to query a specific consumer group.

URI

GET /v2/{project_id}/instances/{instance_id}/groups/{group}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

group

Yes

String

Consumer group ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

group

group object

Consumer group information.

Table 3 group

Parameter

Type

Description

group_id

String

Consumer group name.

state

String

Consumer group status. The value can be:

  • Dead: The consumer group has no members and no metadata.

  • Empty: The consumer group has metadata but has no members.

  • PreparingRebalance: The consumer group is to be rebalanced.

  • CompletingRebalance: All members have jointed the group.

  • Stable: Members in the consumer group can consume messages normally.

coordinator_id

Integer

Coordinator ID.

members

Array of members objects

Consumer list.

group_message_offsets

Array of group_message_offsets objects

Consumer offset.

assignment_strategy

String

Partition assignment policy.

Table 4 members

Parameter

Type

Description

host

String

Consumer address.

member_id

String

Consumer ID.

client_id

String

Client ID.

Table 5 group_message_offsets

Parameter

Type

Description

partition

Integer

Partition number.

lag

Integer

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

topic

String

Topic name.

message_current_offset

Integer

Consumer offset.

message_log_end_offset

Integer

Log end offset (LEO).

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}

Example Responses

Status code: 200

A specific consumer group is queried successfully.

{
  "group" : null,
  "members" : [ {
    "host" : "/172.31.1.102",
    "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785",
    "client_id" : "consumer-1"
  } ],
  "state" : "STABLE",
  "group_id" : "test-consumer-group",
  "coordinator_id" : 2,
  "group_message_offsets" : [ {
    "partition" : 0,
    "lag" : 31396,
    "topic" : "test",
    "message_current_offset" : 935,
    "message_log_end_offset" : 32331
  }, {
    "partition" : 0,
    "lag" : 0,
    "topic" : "aaaa",
    "message_current_offset" : 0,
    "message_log_end_offset" : 0
  }, {
    "partition" : 1,
    "lag" : 31279,
    "topic" : "test",
    "message_current_offset" : 1058,
    "message_log_end_offset" : 32337
  }, {
    "partition" : 1,
    "lag" : 0,
    "topic" : "aaaa",
    "message_current_offset" : 0,
    "message_log_end_offset" : 0
  }, {
    "partition" : 2,
    "lag" : 31603,
    "topic" : "test",
    "message_current_offset" : 739,
    "message_log_end_offset" : 32342
  } ],
  "assignment_strategy" : "range"
}

Status Codes

Status Code

Description

200

A specific consumer group is queried successfully.

Error Codes

See Error Codes.