GetCheckPoint接口用于获取指定消费组消费某个或者所有Shard的checkpoint。

请求语法

GetCheckPoint请求语法如下。
GET /logstores/<logstoreName>/consumergroups/<consumerGroup>?shard=<shardId> 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/json
Connection: Keep-Alive

请求参数

  • 请求头

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

  • 请求参数
    属性名称 类型 是否必须 描述
    logstoreName string 消费组所属Logstore的名称。
    consumerGroup string 消费组名称。
    shardId integer Shard ID。
    • 如果指定的Shard不存在则返回空列表。
    • 如果不指定Shard则返回所有Shard的checkpoint。

响应参数

  • 响应头

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

  • 响应元素
    GetCheckPoint请求成功,其响应Body会包含指定消费组消费的Shard的checkpoint,具体格式如下。
    属性名称 类型 描述
    shard integer Shard ID。
    checkpoint string checkpoint的值。
    updateTime integer checkpoint最后的更新时间。
    consumer string Shard所属的消费者。

错误码

除了返回Log Service API的通用错误码,还可能返回如下特有错误码。
HTTP状态码 ErrorCode ErrorMessage
404 ProjectNotExist The Project does not exist : {Project}
404 LogStoreNotExist logstore {logstoreName} dose not exist
404 ConsumerGroupNotExist consumer group not exist
500 InternalServerError Specified Server Error Message

示例

  • 请求示例
    GET /logstores/my-logstore/consumergroups/consumer_group_test?shard=0
    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 09:26:53 GMT
    Content-Type: application/x-protobuf
    Connection: Keep-Alive
  • 响应示例
    HTTP/1.1 200
    Server: nginx/1.12.1
    Content-Type: application/json
    Content-Length: 111
    Connection: close
    Access-Control-Allow-Origin: *
    Date: Fri, 04 May 2018 09:26:53 GMT
    x-log-requestid: 5AEC275D1FFC036AB254B20C
    [
      {
        "shard": 0,
        "checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng==",
        "updateTime": 1524224984800922,
        "consumer": "consumer_1"
      }
    ]