调用ListConsumerGroup接口查询指定Logstore的所有消费组。

请求语法

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

请求参数

  • 请求头

    ListConsumerGroup接口无特有请求头,关于Log Service API的公共请求头,请参见公共请求头

  • 参数列表
    属性名称 类型 是否必须 示例值 描述
    logstoreName string my-logstore Logstore的名称。

返回数据

  • 响应头

    ListConsumerGroup接口无特有响应头,关于Log Service API的公共响应头,请参见公共响应头

  • 响应元素
    HTTP状态码返回200则ListConsumerGroup请求成功,其响应Body会包括指定Project和Logstore下的所有消费组列表,具体如下:
    属性名称 类型 示例值 描述
    consumerGroup string test-consumer-group 消费组名称。
    timeout integer 30 超时时间,在超时时间段内没有收到心跳,消费组将被删除。
    order bool true 是否按顺序消费。

示例

  • 请求示例
    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
  • 正常返回示例
    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
      }
    ]

错误码

HTTP状态码 错误码 错误信息 描述
404 ProjectNotExist The Project does not exist : {Project}. 项目不存在。
404 LogStoreNotExist logstore {logstoreName} dose not exist. 日志库不存在。
500 InternalServerError Specified Server Error Message. 内部服务调用错误。

更多错误码,请参见通用错误码