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	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
group	Yes	String	Consumer group name.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
enabled	Boolean	Whether consumption is allowed.
broadcast	Boolean	Whether to broadcast.
brokers	Array of strings	List of associated brokers.
name	String	Consumer group name.
group_desc	String	Consumer group description.
retry_max_time	Integer	Maximum number of retries.
app_id	String	Application ID.
app_name	String	Application name.
permissions	Array of strings	Permission.

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",
  "enabled" : true,
  "broadcast" : true,
  "brokers" : [ "broker-0" ],
  "permissions" : [ ],
  "retry_max_time" : 10,
  "app_id" : null,
  "app_name" : null
}