DescribeConsumerGroups

Retrieves a list of consumer groups.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
GwClusterId	string	Yes	The ID of the gateway instance.	pg-xxxxxxx
ConsumerGroupId	string	No	The ID of the consumer group.	cg-xxxxxxxx
PageSize	integer	No	The number of records to return per page. Valid values: 30 50 100 The default value is 30.	30
PageNumber	integer	No	The page number to return. The default value is 1.	1
RegionId	string	No	The ID of the region.	cn-beijing

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	24A1990B-4F6E-482B-B8CB-75C612******
TotalRecordCount	integer	The total number of records.	1
PageRecordCount	integer	The number of records on the current page.	30
PageNumber	integer	The page number.	1
PageSize	integer	The number of records returned per page. Valid values: 30, 50, and 100. Default value: 30.	30
Items	array<object>	A list of consumer groups.
	object	A consumer group object.
IsDefault	string	Indicates whether the consumer group is the default group. Valid values: 0: No 1: Yes	0
ConsumerGroupId	string	The ID of the consumer group.	cg-xxxxxxxx
ConsumerGroupName	string	The name of the consumer group.	test
NickName	string	The nickname of the consumer group.	test
GmtCreated	string	The creation time.	2026-01-28T09:56:03+08:00
GmtModified	string	The update time.	2026-01-04T16:09:29+08:00
AllowedModels	string	The list of supported models.	"[]"

Examples

Success response

JSON format

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "IsDefault": "0",
      "ConsumerGroupId": "cg-xxxxxxxx",
      "ConsumerGroupName": "test",
      "NickName": "test",
      "GmtCreated": "2026-01-28T09:56:03+08:00",
      "GmtModified": "2026-01-04T16:09:29+08:00",
      "AllowedModels": "\"[]\""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.