调用UpdateCheckpoint接口更新指定Project和Logstore下的Consumer Group的某个Shard的checkpoint。

接口说明

当不指定消费者时,必须指定forceSuccess为true才能更新checkpoint。

请求语法

POST /logstores/<logstoreName>/consumergroups/<consumerGroupName>?forceSuccess=<forceSuccess>&type=checkpoint&consumer=<consumer> 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
Content-Length: <ContentLength>
Connection: Keep-Alive
{
  "shard": <shardID>,
  "checkpoint": <checkpoint>
}

请求参数

  • 请求头

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

  • 参数列表
    名称 类型 是否必须 示例值 描述
    logstoreName string logstore-4 消费组所属Logstore的名称。
    consumerGroup string consumer_group_test 消费组名称。
    forceSuccess bool false 是否强制更新。
    consumer string consumer_1 消费者。
    shard integer 0 Shard ID。
    checkpoint string MTUyNDE1NTM3OTM3MzkwODQ5Ng== checkpoint值。

返回数据

  • 响应头

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

  • 响应元素

    HTTP状态码返回200。

示例

  • 请求示例
    POST /logstores/logstore-4/consumergroups/consumer_group_test?forceSuccess=false&type=checkpoint&consumer=consumer_1 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: Sun, 06 May 2018 09:14:53 GMT
    Content-Type: application/json
    Content-MD5: 59457BAFB3F85A5117BDE243947583B0
    Content-Length: 55
    Connection: Keep-Alive
    {
      "shard": 0,
      "checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng=="
    }
  • 正常返回示例
    HTTP/1.1 200
    Server: nginx/1.12.1
    Content-Length: 0
    Connection: close
    Access-Control-Allow-Origin: *
    Date: Sun, 06 May 2018 09:14:54 GMT
    x-log-requestid: 5AEEC78E1FFC0366B24F1C63

错误码

HTTP状态码 错误码 错误信息 描述
400 InvalidShardCheckPoint shard checkpoint not encoded by base64. Shard checkpoint不是由base64编码的。
404 ProjectNotExist The Project does not exist : {Project}. 项目不存在。
404 LogStoreNotExist logstore {logstoreName} dose not exist. 日志库不存在。
404 ConsumerGroupNotExist consumer group not exist. 消费组不存在。
404 ShardNotExist shard not exist. Shard不存在。
500 InternalServerError Specified Server Error Message. 内部服务调用错误。

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