Call the DescribeConsumerGroups interface to obtain information about all consumer groups under a project.

Usage notes

This interface is used to view the list of consumer group information under the specified project. It supports pagination and offset-based queries.

The call frequency limit for this interface is 20 times/s. Exceeding the frequency limit will cause an ExceedQPSLimit error.

Request syntax

Request Method：GET

Request URL：https://{tls-endpoint}/DescribeConsumerGroups

Request parameters

The table below only lists the request parameters specific to this interface and some common parameters. For more information, please see Common parameters.

Query

Name	Type	Required	Example	Description
PageNumber	Integer	False	1	The page number for pagination queries. The default is 1, which means data begins to return from the first page.
PageSize	Integer	False	10	Page size. The default is 20, with a maximum of 100.
ConsumerGroupName	String	False	"test-consumergroup"	The name of the consumer group.
ProjectId	String	False	"fa************"	The ID of the project to which the consumer group belongs.
ProjectName	String	False	pt*****	The name of the project to which the consumer group belongs.
TopicId	String	False	"fa************"	The ID of the topic to which the consumer group belongs.
TopicName	String	False	test	The name of the topic to which the consumer group belongs.
IamProjectName	String	False	test	The name of the IAM project.

Responses

The table below only lists the return parameters specific to this interface. For more information, please refer to the Response message.

Name	Type	Example	Description
ConsumerGroups	Array of ConsumerGroupResp	{"Consumer Groups ": [ { " Project ID": "32 ********", " Consumer Group Name": "test-consumer-group", "HeartbeatTTL": 60, "OrderedConsume": false}]}	The list of consumer groups.
DashboardId	String	/	The default built-in dashboard ID, specifically for Kafka consumption protocol.
Total	Integer	1	The total number of consumer groups.

ConsumerGroupResp

Name	Type	Example	Description
topic_id	Array of String	c7******	The list of topics subscribed by the consumer group.
ProjectID	String	c7******	The project ID subscribed by the consumer group.
ProjectName	String	test	The project name subscribed by the consumer group.
HeartbeatTTL	Integer	60	The heartbeat expiration time, in seconds.
OrderedConsume	Boolean	false	Whether to consume the logs in order. true: Consume the logs in order within the shard. After the shard is split, the original shard data is consumed first, and then the shard data split from that shard is consumed in parallel; After the shard is merged, the original shard data is consumed first, and then the new shard data merged from the original shard is consumed. false: Do not consume the logs in order. That is, all shards are consumed at the same time, and the new shards generated after the shard is split or merged will also be consumed immediately.
ConsumerGroupName	String	my-consumer-group	The name of the consumer group.

Sample Request

Sample Response

Error code

The following table lists the error codes related to the interface and business logic. For common error codes, please refer to the Common error codes.

HTTP status code	Error code	Error message	Description
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	The parameter is invalid.
500	InternalServerError	We encountered an unexpected server error, please try again later.	Internal server error.

Torch Log Service