Queries all consumer groups of a specified Logstore.

Description

Host consists of a project name and a Log Service endpoint. You must specify a project in Host.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

GET /logstores/{logstore}/consumergroups HTTP/1.1

Request parameters

Parameter Type Location Required Example Description
project String Host Yes ali-test-project

The name of the project.

logstore String Path Yes ali-test-logstore

The name of the Logstore.

Response parameters

Parameter Type Example Description
Array of ConsumerGroup

An array that consists of consumer groups.

Examples

Sample requests

GET /logstores/logstoreName/consumergroups HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

Common request parameters

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

[ {
  "name" : "test-consumer-group",
  "timeout" : 30,
  "order" : false
} ]

Error codes

For a list of error codes, visit the API Error Center.

HTTP status code

Error code

Error message

Description

404

ProjectNotExist

Project does not exist.

The error message returned because the specified project does not exist.

404

LogStoreNotExist

Logstore does not exist.

The error message returned because the specified Logstore does not exist.

500

InternalServerError

Specified Server Error Message.

The error message returned because an internal server error has occurred.

For more information, see Common error codes.