Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Consumer Group Management/ Querying a Consumer Group
Updated on 2026-04-30 GMT+08:00
View PDF

Querying a Consumer Group

Function

This API is used to query details about a specified consumer group.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

group

Yes

String

Definition

Consumer group name.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

enabled

Boolean

Definition

Whether consumption is allowed.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

broadcast

Boolean

Definition

Whether to enable broadcast.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

brokers

Array of strings

Definition

List of associated brokers.

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

Consumer group name.

Constraints

N/A

Range

N/A

Default Value

N/A

group_desc

String

Definition

Consumer group description.

Constraints

N/A

Range

N/A

Default Value

N/A

created_at

Long

Definition

Creation time.

Constraints

N/A

Range

N/A

Default Value

N/A

retry_max_time

Integer

Definition

Maximum number of retries.

Constraints

N/A

Range

N/A

Default Value

N/A

permissions

Array of strings

Definition

Permission.

Constraints

N/A

Range

N/A

Default Value

N/A

consume_orderly

Boolean

Definition

Whether to enable orderly consumption.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

Example Requests

Querying details about a specified consumer group

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

Example Responses

Status code: 200

Consumer group queried successfully.

{
  "name" : "test",
  "group_desc" : "group_description",
  "enabled" : true,
  "broadcast" : true,
  "permissions" : [ ],
  "retry_max_time" : 10,
  "consume_orderly" : false,
  "created_at" : 1768549443385
}

Status Codes

Status Code

Description

200

Consumer group queried successfully.

Error Codes

See Error Codes.

Parent Topic: Consumer Group Management