Lists all consumer groups of a specified Logstore.

Request syntax

GET /logstores/<logstoreName>/consumergroups HTTP/1.1
Authorization: <AuthorizationString>
x-log-bodyrawsize: 0
User-Agent: <UserAgent>
x-log-apiversion: 0.6.0
Host: <Project Endpoint>
x-log-signaturemethod: hmac-sha1
Date: <GMT Date>
Content-Type: application/x-protobuf
Connection: Keep-Alive

Request parameters

  • Request headers

    The ListConsumerGroup operation does not have operation-specific request headers. For information about the common request headers of Log Service API operations, see Common request headers.

  • Parameters
    Parameter Type Required Example Description
    logstoreName string Yes my-logstore The name of the Logstore.

Response parameters

  • Response headers

    The ListConsumerGroup operation does not have operation-specific response headers. For information about the common response headers of Log Service API operations, see Common response headers.

  • Response elements
    If the request succeeds, the HTTP status code 200 is returned. The response body contains a list of all consumer groups of the specified project and Logstore. The following table describes the parameters of the response body.
    Parameter Type Example Description
    consumerGroup string test-consumer-group The name of the consumer group.
    timeout integer 30 The timeout period. If Log Service does not receive heartbeat messages from the consumer group within the timeout period, the consumer group is deleted.
    order bool true Specifies whether to consume log data in sequence.

Examples

  • Sample requests
    GET /logstores/my-logstore/consumergrops HTTP/1.1
    Authorization: LOG <yourAccessKeyId>:<yourSignature>
    x-log-bodyrawsize: 0
    User-Agent: sls-java-sdk-v-0.6.1
    x-log-apiversion: 0.6.0
    Host: my-project.cn-shanghai.log.aliyuncs.com
    x-log-signaturemethod: hmac-sha1
    Date: Fri, 04 May 2018 08:47:30 GMT
    Content-Type: application/x-protobuf
    Connection: Keep-Alive
  • Sample success responses
    HTTP/1.1 200
    Server: nginx/1.12.1
    Content-Type: application/json
    Connection: close
    Access-Control-Allow-Origin: *
    Date: Fri, 04 May 2018 08:47:31 GMT
    x-log-requestid: 5AEC1E23048191954B42EAB9
    [
      {
        "name": "test-consumer-group",
        "timeout": 30,
        "order": true
      }
    ]

Error codes

HTTP status code Error code Error message Description
404 ProjectNotExist The Project does not exist : {Project}. The error message returned because the specified project does not exist.
404 LogStoreNotExist logstore {logstoreName} 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 about the error codes, see Common error codes.